engine

Documentation

Index

• Constants
• func NewDailySummarySetting(inStore settingspanel.SettingStore, ...) settingspanel.Setting
• func NewNotificationsSetting(getCal func(string) Engine) settingspanel.Setting
• func NewOAuth2App(env Env) oauth2connect.App
• func NewPostActionForEventResponse(eventID, response, url string) []*model.PostAction
• func NewSettingsPanel(bot bot.Bot, panelStore settingspanel.PanelStore, ...) settingspanel.Panel
• type Availability
• type Bot
  • func NewMSCalendarBot(bot bot.Bot, env Env, pluginURL string) Bot
• type Calendar
• type Client
• type DailySummary
• type Dependencies
• type Engine
  • func New(env Env, actingMattermostUserID string) Engine
• type Env
• type EventResponder
• type NotificationProcessor
  • func NewNotificationProcessor(env Env) NotificationProcessor
• type PluginAPI
• type Settings
• type StatusSyncJobSummary
• type Subscriptions
• type User
  • func NewUser(mattermostUserID string) *User
  • func (user *User) Clone() *User
  • func (user *User) Markdown() string
  • func (user *User) String() string
• type Users
• type WelcomeFlow
  • func NewWelcomeFlow(bot bot.FlowController, welcomer Welcomer, ...) *WelcomeFlow
  • func (wf *WelcomeFlow) FlowDone(userID string)
  • func (wf *WelcomeFlow) Length() int
  • func (wf *WelcomeFlow) Step(i int) flow.Step
  • func (wf *WelcomeFlow) StepDone(userID string, step int, value bool)
  • func (wf *WelcomeFlow) URL() string
• type Welcomer

Constants

const (
	FieldSubject        = "Subject"
	FieldBodyPreview    = "BodyPreview"
	FieldImportance     = "Importance"
	FieldDuration       = "Duration"
	FieldWhen           = "When"
	FieldLocation       = "Location"
	FieldAttendees      = "Attendees"
	FieldOrganizer      = "Organizer"
	FieldResponseStatus = "ResponseStatus"
)

const (
	OptionYes          = "Yes"
	OptionNotResponded = "Not responded"
	OptionNo           = "No"
	OptionMaybe        = "Maybe"
)

const (
	ResponseYes   = "accepted"
	ResponseMaybe = "tentativelyAccepted"
	ResponseNo    = "declined"
	ResponseNone  = "notResponded"
)

const BotWelcomeMessage = "Bot user connected to account %s."

const DailySummaryJobInterval = 15 * time.Minute

Run daily summary job every 15 minutes

const RemoteUserAlreadyConnected = "" /* 132-byte string literal not displayed */

const RemoteUserAlreadyConnectedNotFound = "%s account `%s` is already mapped to a Mattermost account, but the Mattermost user could not be found"

const (
	StatusSyncJobInterval = 5 * time.Minute
)

const (
	WelcomeMessage = `Welcome to the %s plugin. [Click here to link your account.](%s/oauth2/connect)`
)

Functions

func NewDailySummarySetting

func NewDailySummarySetting(inStore settingspanel.SettingStore, getTimezone func(userID string) (string, error)) settingspanel.Setting

func NewNotificationsSetting

func NewNotificationsSetting(getCal func(string) Engine) settingspanel.Setting

func NewOAuth2App

func NewOAuth2App(env Env) oauth2connect.App

func NewPostActionForEventResponse

func NewPostActionForEventResponse(eventID, response, url string) []*model.PostAction

func NewSettingsPanel

func NewSettingsPanel(bot bot.Bot, panelStore settingspanel.PanelStore, settingStore settingspanel.SettingStore, settingsHandler, pluginURL string, getCal func(userID string) Engine, providerFeatures config.ProviderFeatures) settingspanel.Panel

Types

type Availability

type Availability interface {
	GetCalendarViews(users []*store.User) ([]*remote.ViewCalendarResponse, error)
	Sync(mattermostUserID string) (string, *StatusSyncJobSummary, error)
	SyncAll() (string, *StatusSyncJobSummary, error)
}

type Bot

type Bot interface {
	bot.Bot
	Welcomer
	flow.Store
}

func NewMSCalendarBot

func NewMSCalendarBot(bot bot.Bot, env Env, pluginURL string) Bot

type Calendar

type Calendar interface {
	CreateCalendar(user *User, calendar *remote.Calendar) (*remote.Calendar, error)
	CreateEvent(user *User, event *remote.Event, mattermostUserIDs []string) (*remote.Event, error)
	DeleteCalendar(user *User, calendarID string) error
	FindMeetingTimes(user *User, meetingParams *remote.FindMeetingTimesParameters) (*remote.MeetingTimeSuggestionResults, error)
	GetCalendars(user *User) ([]*remote.Calendar, error)
	ViewCalendar(user *User, from, to time.Time) ([]*remote.Event, error)
}

type Client

type Client interface {
	MakeClient() (remote.Client, error)
	MakeSuperuserClient() (remote.Client, error)
}

type DailySummary

type DailySummary interface {
	GetDaySummaryForUser(now time.Time, user *User) (string, error)
	GetDailySummarySettingsForUser(user *User) (*store.DailySummaryUserSettings, error)
	SetDailySummaryPostTime(user *User, timeStr string) (*store.DailySummaryUserSettings, error)
	SetDailySummaryEnabled(user *User, enable bool) (*store.DailySummaryUserSettings, error)
	ProcessAllDailySummary(now time.Time) error
}

type Dependencies

type Dependencies struct {
	Logger            bot.Logger
	PluginAPI         PluginAPI
	Poster            bot.Poster
	Remote            remote.Remote
	Store             store.Store
	SettingsPanel     settingspanel.Panel
	IsAuthorizedAdmin func(string) (bool, error)
	Welcomer          Welcomer
	Tracker           tracker.Tracker
}

Dependencies contains all API dependencies

type Engine

type Engine interface {
	Availability
	Calendar
	EventResponder
	Subscriptions
	Users
	Welcomer
	Settings
	DailySummary
}

func New

func New(env Env, actingMattermostUserID string) Engine

type Env

type Env struct {
	*config.Config
	*Dependencies
}

type EventResponder

type EventResponder interface {
	AcceptEvent(user *User, eventID string) error
	DeclineEvent(user *User, eventID string) error
	TentativelyAcceptEvent(user *User, eventID string) error
	RespondToEvent(user *User, eventID, response string) error
}

type NotificationProcessor

type NotificationProcessor interface {
	Configure(Env)
	Enqueue(notifications ...*remote.Notification) error
	Quit()
}

func NewNotificationProcessor

func NewNotificationProcessor(env Env) NotificationProcessor

type PluginAPI

type PluginAPI interface {
	GetMattermostUser(mattermostUserID string) (*model.User, error)
	GetMattermostUserByUsername(mattermostUsername string) (*model.User, error)
	GetMattermostUserStatus(mattermostUserID string) (*model.Status, error)
	GetMattermostUserStatusesByIds(mattermostUserIDs []string) ([]*model.Status, error)
	IsSysAdmin(mattermostUserID string) (bool, error)
	UpdateMattermostUserStatus(mattermostUserID, status string) (*model.Status, error)
	GetPost(postID string) (*model.Post, error)
	CanLinkEventToChannel(channelID, userID string) bool
	SearchLinkableChannelForUser(teamID, mattemostUserID, search string) ([]*model.Channel, error)
	GetMattermostUserTeams(mattermostUserID string) ([]*model.Team, error)
	PublishWebsocketEvent(mattermostUserID, event string, payload map[string]any)
}

type Settings

type Settings interface {
	PrintSettings(userID string)
	ClearSettingsPosts(userID string)
}

type StatusSyncJobSummary

type StatusSyncJobSummary struct {
	NumberOfUsersFailedStatusChanged int
	NumberOfUsersStatusChanged       int
	NumberOfUsersProcessed           int
}

type Subscriptions

type Subscriptions interface {
	CreateMyEventSubscription() (*store.Subscription, error)
	RenewMyEventSubscription() (*store.Subscription, error)
	DeleteOrphanedSubscription(*store.Subscription) error
	DeleteMyEventSubscription() error
	ListRemoteSubscriptions() ([]*remote.Subscription, error)
	LoadMyEventSubscription() (*store.Subscription, error)
}

type User

type User struct {
	*store.User
	MattermostUser   *model.User
	MattermostUserID string
}

func NewUser

func NewUser(mattermostUserID string) *User

func (*User) Clone

func (user *User) Clone() *User

func (*User) Markdown

func (user *User) Markdown() string

func (*User) String

func (user *User) String() string

type Users

type Users interface {
	GetActingUser() *User
	GetTimezone(user *User) (string, error)
	DisconnectUser(mattermostUserID string) error
	GetRemoteUser(mattermostUserID string) (*remote.User, error)
	IsAuthorizedAdmin(mattermostUserID string) (bool, error)
	GetUserSettings(user *User) (*store.Settings, error)
}

type WelcomeFlow

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

func NewWelcomeFlow

func NewWelcomeFlow(bot bot.FlowController, welcomer Welcomer, providerFeatures config.ProviderFeatures) *WelcomeFlow

func (*WelcomeFlow) FlowDone

func (wf *WelcomeFlow) FlowDone(userID string)

func (*WelcomeFlow) Length

func (wf *WelcomeFlow) Length() int

func (*WelcomeFlow) Step

func (wf *WelcomeFlow) Step(i int) flow.Step

func (*WelcomeFlow) StepDone

func (wf *WelcomeFlow) StepDone(userID string, step int, value bool)

func (*WelcomeFlow) URL

func (wf *WelcomeFlow) URL() string

type Welcomer

type Welcomer interface {
	Welcome(userID string) error
	AfterSuccessfullyConnect(userID, userLogin string) error
	AfterDisconnect(userID string) error
	WelcomeFlowEnd(userID string)
}