accesslist

Documentation

Index

• func NewApp(bot MessagingBot) common.App
• type App
  • func (a *App) Err() error
  • func (a *App) Init(baseApp *common.BaseApp) error
  • func (a *App) Start(process *lib.Process)
  • func (a *App) WaitForDone()
  • func (a *App) WaitReady(ctx context.Context) (bool, error)
• type MessagingBot

Functions

func NewApp

func NewApp(bot MessagingBot) common.App

NewApp will create a new access list application.

Types

type App

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

App is the access list application for plugins. This will notify access list owners when they need to review an access list.

func (*App) Err

func (a *App) Err() error

Err will return the error associated with the underlying job.

func (*App) Init

func (a *App) Init(baseApp *common.BaseApp) error

Init will initialize the application.

func (*App) Start

func (a *App) Start(process *lib.Process)

Start will start the application.

func (*App) WaitForDone

func (a *App) WaitForDone()

WaitForDone will wait until the job has completed.

func (*App) WaitReady

func (a *App) WaitReady(ctx context.Context) (bool, error)

WaitReady will block until the job is ready.

type MessagingBot

type MessagingBot interface {
	common.MessagingBot

	// SendReviewReminders will send a review reminder that an access list needs to be reviewed.
	SendReviewReminders(ctx context.Context, recipient common.Recipient, accessList *accesslist.AccessList) error
}