boards

Documentation

Overview

Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved. See LICENSE.txt for license information.

Index

• Constants
• Variables
• type BoardsApp
  • func NewBoardsApp(api model.ServicesAPI) (*BoardsApp, error)
  • func (b *BoardsApp) MessageWillBePosted(_ *plugin.Context, post *mm_model.Post) (*mm_model.Post, string)
  • func (b *BoardsApp) MessageWillBeUpdated(_ *plugin.Context, newPost, _ *mm_model.Post) (*mm_model.Post, string)
  • func (b *BoardsApp) OnConfigurationChange() error
  • func (b *BoardsApp) OnPluginClusterEvent(_ *plugin.Context, ev mm_model.PluginClusterEvent)
  • func (b *BoardsApp) OnWebSocketConnect(webConnID, userID string)
  • func (b *BoardsApp) OnWebSocketDisconnect(webConnID, userID string)
  • func (b *BoardsApp) RunDataRetention(nowTime, batchSize int64) (int64, error)
  • func (b *BoardsApp) ServeHTTP(_ *plugin.Context, w http.ResponseWriter, r *http.Request)
  • func (b *BoardsApp) Start() error
  • func (b *BoardsApp) Stop() error
  • func (b *BoardsApp) WebSocketMessageHasBeenPosted(webConnID, userID string, req *mm_model.WebSocketRequest)
• type BoardsEmbed

Constants

const (
	PluginName       = "focalboard"
	SharedBoardsName = "enablepublicsharedboards"
)

Variables

var ErrInsufficientLicense = errors.New("appropriate license required")

Types

type BoardsApp

type BoardsApp struct {
	// contains filtered or unexported fields
}

func NewBoardsApp

func NewBoardsApp(api model.ServicesAPI) (*BoardsApp, error)

func (*BoardsApp) MessageWillBePosted

func (b *BoardsApp) MessageWillBePosted(_ *plugin.Context, post *mm_model.Post) (*mm_model.Post, string)

func (*BoardsApp) MessageWillBeUpdated

func (b *BoardsApp) MessageWillBeUpdated(_ *plugin.Context, newPost, _ *mm_model.Post) (*mm_model.Post, string)

func (*BoardsApp) OnConfigurationChange

func (b *BoardsApp) OnConfigurationChange() error

OnConfigurationChange is invoked when configuration changes may have been made.

func (*BoardsApp) OnPluginClusterEvent

func (b *BoardsApp) OnPluginClusterEvent(_ *plugin.Context, ev mm_model.PluginClusterEvent)

func (*BoardsApp) OnWebSocketConnect

func (b *BoardsApp) OnWebSocketConnect(webConnID, userID string)

func (*BoardsApp) OnWebSocketDisconnect

func (b *BoardsApp) OnWebSocketDisconnect(webConnID, userID string)

func (*BoardsApp) RunDataRetention

func (b *BoardsApp) RunDataRetention(nowTime, batchSize int64) (int64, error)

func (*BoardsApp) ServeHTTP

func (b *BoardsApp) ServeHTTP(_ *plugin.Context, w http.ResponseWriter, r *http.Request)

ServeHTTP demonstrates a plugin that handles HTTP requests by greeting the world.

func (*BoardsApp) Start

func (b *BoardsApp) Start() error

func (*BoardsApp) Stop

func (b *BoardsApp) Stop() error

func (*BoardsApp) WebSocketMessageHasBeenPosted

func (b *BoardsApp) WebSocketMessageHasBeenPosted(webConnID, userID string, req *mm_model.WebSocketRequest)

type BoardsEmbed

type BoardsEmbed struct {
	OriginalPath string `json:"originalPath"`
	TeamID       string `json:"teamID"`
	ViewID       string `json:"viewID"`
	BoardID      string `json:"boardID"`
	CardID       string `json:"cardID"`
	ReadToken    string `json:"readToken,omitempty"`
}