settings

package

v0.0.22 Latest Latest Go to latest Published: Jan 19, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mattermost/mattermost-plugin-api

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	// ContextIDKey defines the key used in the context to store the ID
	ContextIDKey = "setting_id"
	// ContextButtonValueKey defines the key used in the context to store a button value
	ContextButtonValueKey = "button_value"
	// ContextOptionValueKey defines the key used in the context to store a selected option value
	ContextOptionValueKey = "selected_option"

	// DisabledString defines the string used to show that a setting is disabled
	DisabledString = "Disabled"
	// TrueString codify the boolean true into a string
	TrueString = "true"
	// FalseString codify the boolean false into a string
	FalseString = "false"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type FreetextInfo ¶

type FreetextInfo struct {
	SettingID string
	UserID    string
}

FreetextInfo defines the information needed in the payload for freetext settings

type Setting ¶

type Setting interface {
	Set(userID string, value interface{}) error
	Get(userID string) (interface{}, error)
	GetID() string
	GetDependency() string
	IsDisabled(foreignValue interface{}) bool
	GetTitle() string
	GetDescription() string
	GetSlackAttachments(userID, settingHandler string, disabled bool) (*model.SlackAttachment, error)
	GetFreetextFetcher() freetextfetcher.FreetextFetcher
}

Setting defines the behavior of each element a the panel

func NewBoolSetting ¶

func NewBoolSetting(id, title, description, dependsOn string, store SettingStore) Setting

NewBoolSetting creates a new setting input for boolean values

func NewEmptySetting ¶

func NewEmptySetting(id, title, description string) Setting

NewEmptySetting creates a new panel value with no setting attached

func NewFreetextSetting ¶

func NewFreetextSetting(
	id,
	title,
	description,
	modifyMessage,
	dependsOn string,
	store SettingStore,
	baseURL,
	pluginURL string,
	ftfStore freetextfetcher.FreetextStore,
	validate func(string) string,
	r *mux.Router,
	p poster.Poster,
) Setting

NewFreetextSetting creates a new setting input to add any text

func NewOptionSetting ¶

func NewOptionSetting(id, title, description, dependsOn string, options []string, store SettingStore) Setting

NewOptionSetting creates a new setting input to select from a dropdown

func NewReadOnlySetting ¶

func NewReadOnlySetting(id, title, description, dependsOn string, store SettingStore) Setting

NewReadOnlySetting creates a new panel value that only read from the setting

type SettingStore ¶

type SettingStore interface {
	SetSetting(userID, settingID string, value interface{}) error
	GetSetting(userID, settingID string) (interface{}, error)
}

SettingStore defines the behavior needed to set and get settings

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL