todoitem

Documentation

Overview

Package todoitem contains the core business logic for the todoitem service.

Index

• type Event
• type GetToDoItemsInput
• type Service
  • func NewService(logger logger.Logger, dbClient *db.Client, eventManager *events.EventManager) Service
• type UpdateToDoItemInput

Types

type Event

type Event struct {
	ToDoItem        *models.ToDoItem
	Action          string
	TotalUnresolved int32
}

Event is the output of subscribing to ToDoItems.

type GetToDoItemsInput

type GetToDoItemsInput struct {
	Sort              *db.ToDoItemSortableField
	PaginationOptions *pagination.Options
	OrganizationID    *string
	ProjectID         *string
	Resolved          *bool
	TargetTypes       []models.ToDoItemTargetType
}

GetToDoItemsInput represents the input for getting todo items.

type Service

type Service interface {
	GetToDoItemByPRN(ctx context.Context, prn string) (*models.ToDoItem, error)
	CreateToDoItemSubscription(ctx context.Context) (<-chan *Event, error)
	GetToDoItems(ctx context.Context, input *GetToDoItemsInput) (*db.ToDoItemsResult, error)
	UpdateToDoItem(ctx context.Context, input *UpdateToDoItemInput) (*models.ToDoItem, error)
}

Service encapsulates the core business logic for the todo item service.

func NewService

func NewService(
	logger logger.Logger,
	dbClient *db.Client,
	eventManager *events.EventManager,
) Service

NewService creates a new todo item service.

type UpdateToDoItemInput

type UpdateToDoItemInput struct {
	Resolved *bool
	Version  *int
	ID       string
}

UpdateToDoItemInput represents the input for updating a todo item.