transmission

Documentation

Index

• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
• type Widget
  • func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget
  • func (widget *Widget) Fetch() ([]*transmissionrpc.Torrent, error)
  • func (widget *Widget) HelpText() string
  • func (widget *Widget) Next()
  • func (widget *Widget) Prev()
  • func (widget *Widget) Refresh()
  • func (widget *Widget) Unselect()

Types

type Settings

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

Settings defines the configuration properties for this module

func NewSettingsFromYAML

func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings

NewSettingsFromYAML creates a new settings instance from a YAML config block

type Widget

type Widget struct {
	view.KeyboardWidget
	view.ScrollableWidget
	// contains filtered or unexported fields
}

Widget is the container for transmission data

func NewWidget

func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget

NewWidget creates a new instance of a widget

func (*Widget) Fetch

func (widget *Widget) Fetch() ([]*transmissionrpc.Torrent, error)

Fetch retrieves torrent data from the Transmission daemon

func (*Widget) HelpText

func (widget *Widget) HelpText() string

HelpText returns the help text for this widget

func (*Widget) Next

func (widget *Widget) Next()

Next selects the next item in the list

func (*Widget) Prev

func (widget *Widget) Prev()

Prev selects the previous item in the list

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh updates the data for this widget and displays it onscreen

func (*Widget) Unselect

func (widget *Widget) Unselect()

Unselect clears the selection of list items