app

Documentation

Index

• Constants
• Variables
• type App
  • func New(cfg Config, provider auth.Provider) (*App, error)
  • func (app *App) Close() error
  • func (app *App) Export(ctx context.Context, name string) error
  • func (app *App) Run(ctx context.Context) error
• type Config
  • func (p *Config) Validate() error
• type Input
  • func (in *Input) IsValid() bool
• type ListFlags
  • func (lf ListFlags) FlagsPresent() bool
• type Output
  • func (out Output) FormatValid() bool
  • func (out Output) IsText() bool
• type TimeValue
  • func (tv *TimeValue) Set(s string) error
  • func (tv *TimeValue) String() string

Constants

const (
	OutputTypeJSON = "json"
	OutputTypeText = "text"
)

Variables

var (
	ErrInvalidInput = errors.New("no valid input")
)

Types

type App

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

func New

func New(cfg Config, provider auth.Provider) (*App, error)

New creates a new slackdump app. It inherits the logging from slack options in the Config.

func (*App) Close

func (app *App) Close() error

Close closes all open handles.

func (*App) Export

func (app *App) Export(ctx context.Context, name string) error

Export performs the full export of slack workspace in slack export compatible format.

func (*App) Run

func (app *App) Run(ctx context.Context) error

type Config

type Config struct {
	ListFlags ListFlags

	Input  Input  // parameters of the input
	Output Output // " " output

	Oldest TimeValue // oldest time to dump conversations from
	Latest TimeValue // latest time to dump conversations to

	FilenameTemplate string

	ExportName string

	Options slackdump.Options
}

func (*Config) Validate

func (p *Config) Validate() error

Validate checks if the command line parameters have valid values.

type Input

type Input struct {
	List *structures.EntityList // Include channels
}

func (*Input) IsValid

func (in *Input) IsValid() bool

type ListFlags

type ListFlags struct {
	Users    bool
	Channels bool
}

func (ListFlags) FlagsPresent

func (lf ListFlags) FlagsPresent() bool

type Output

type Output struct {
	Filename string
	Format   string // output format
	Base     string // base directory or zip file
}

func (Output) FormatValid

func (out Output) FormatValid() bool

func (Output) IsText

func (out Output) IsText() bool

type TimeValue

type TimeValue time.Time

func (*TimeValue) Set

func (tv *TimeValue) Set(s string) error

func (*TimeValue) String

func (tv *TimeValue) String() string