usp_box

Documentation

Index

• type BoxAdapter
  • func NewBoxAdapter(ctx context.Context, conf BoxConfig) (*BoxAdapter, chan struct{}, error)
  • func (a *BoxAdapter) Close() error
• type BoxConfig
  • func (c *BoxConfig) Validate() error

Types

type BoxAdapter

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

func NewBoxAdapter

func NewBoxAdapter(ctx context.Context, conf BoxConfig) (*BoxAdapter, chan struct{}, error)

func (*BoxAdapter) Close

func (a *BoxAdapter) Close() error

type BoxConfig

type BoxConfig struct {
	ClientOptions uspclient.ClientOptions `json:"client_options" yaml:"client_options"`
	ClientID      string                  `json:"client_id" yaml:"client_id"`
	ClientSecret  string                  `json:"client_secret" yaml:"client_secret"`
	SubjectID     string                  `json:"subject_id" yaml:"subject_id"`

	// EventsURL overrides the Box enterprise events endpoint. Empty means the
	// public API: https://api.box.com/2.0/events
	EventsURL string `json:"events_url" yaml:"events_url"`

	// TokenURL overrides the Box OAuth2 token endpoint. Empty means the
	// public endpoint: https://api.box.com/oauth2/token
	TokenURL string `json:"token_url" yaml:"token_url"`

	// PollInterval overrides the wait between polls of the events endpoint
	// (default 30s). It is not settable through a config file; it exists as a
	// seam for tests.
	PollInterval time.Duration `json:"-" yaml:"-"`
}

func (*BoxConfig) Validate

func (c *BoxConfig) Validate() error