kanboard

Documentation

Index

• Constants
• type AuthTransport
  • func (t *AuthTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type Comment
• type EventResponse
• type File
• type Kanboard
  • func GetClient() (*Kanboard, error)
  • func NewKanboard(endpoint string, username string, password string) (*Kanboard, error)
  • func (v *Kanboard) Close() error
  • func (v *Kanboard) CreateTask(ctx context.Context, task *Task) (taskId int64, err error)
  • func (v *Kanboard) GetAllTasks(ctx context.Context, projectId int, status StatusId) (tasks []*Task, err error)
• type StatusId
• type Subtask
• type Task
• type TaskClose
• type TaskLink

Constants

const (
	ID              = "kanboard"
	EndpointKey     = "endpoint"
	UsernameKey     = "username"
	PasswordKey     = "password"
	WebhookTokenKey = "webhook_token"
)

const (
	DefaultProjectId = 1
	DefaultPriority  = 2
)

const (
	CommentCreateEvent                = "comment.create"
	CommentUpdateEvent                = "comment.update"
	CommentDeleteEvent                = "comment.delete"
	FileCreateEvent                   = "file.create"
	TaskMoveProjectEvent              = "task.move.project"
	TaskMoveColumnEvent               = "task.move.column"
	TaskMovePositionEvent             = "task.move.position"
	TaskMoveSwimlaneEvent             = "task.move.swimlane"
	TaskUpdateEvent                   = "task.update"
	TaskCreateEvent                   = "task.create"
	TaskCloseEvent                    = "task.close"
	TaskOpenEvent                     = "task.open"
	TaskAssigneeChangeEvent           = "task.assignee_change"
	SubtaskUpdateEvent                = "subtask.update"
	SubtaskCreateEvent                = "subtask.create"
	SubtaskDeleteEvent                = "subtask.delete"
	TaskInternalLinkCreateUpdateEvent = "task_internal_link.create_update"
	TaskInternalLinkDeleteEvent       = "task_internal_link.delete"
)

Types

type AuthTransport

type AuthTransport struct {
	Transport http.RoundTripper
	Username  string
	Password  string
}

func (*AuthTransport) RoundTrip

func (t *AuthTransport) RoundTrip(req *http.Request) (*http.Response, error)

type Comment

type Comment struct {
	ID               int    `json:"id,omitempty"`
	TaskID           int    `json:"task_id,omitempty"`
	UserID           int    `json:"user_id,omitempty"`
	DateCreation     int    `json:"date_creation,omitempty"`
	DateModification int    `json:"date_modification,omitempty"`
	Comment          string `json:"comment,omitempty"`
	Reference        string `json:"reference,omitempty"`
	Visibility       string `json:"visibility,omitempty"`
	Username         string `json:"username,omitempty"`
	Name             any    `json:"name,omitempty"`
	Email            any    `json:"email,omitempty"`
	AvatarPath       string `json:"avatar_path,omitempty"`
}

type EventResponse

type EventResponse struct {
	EventName   string `json:"event_name,omitempty"`
	EventData   any    `json:"event_data,omitempty"`
	EventAuthor string `json:"event_author,omitempty"`
}

type File

type File struct {
	ID      string `json:"id,omitempty"`
	Name    string `json:"name,omitempty"`
	Path    string `json:"path,omitempty"`
	IsImage string `json:"is_image,omitempty"`
	TaskID  string `json:"task_id,omitempty"`
	Date    string `json:"date,omitempty"`
	UserID  string `json:"user_id,omitempty"`
	Size    string `json:"size,omitempty"`
}

type Kanboard

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

func GetClient

func GetClient() (*Kanboard, error)

func NewKanboard

func NewKanboard(endpoint string, username string, password string) (*Kanboard, error)

func (*Kanboard) Close

func (v *Kanboard) Close() error

func (*Kanboard) CreateTask

func (v *Kanboard) CreateTask(ctx context.Context, task *Task) (taskId int64, err error)

func (*Kanboard) GetAllTasks

func (v *Kanboard) GetAllTasks(ctx context.Context, projectId int, status StatusId) (tasks []*Task, err error)

type StatusId

type StatusId int

The value 1 for active tasks and 0 for inactive

const (
	Active   StatusId = 1
	Inactive StatusId = 0
)

type Subtask

type Subtask struct {
	ID             string `json:"id,omitempty"`
	Title          string `json:"title,omitempty"`
	Status         string `json:"status,omitempty"`
	TimeEstimated  any    `json:"time_estimated,omitempty"`
	TimeSpent      any    `json:"time_spent,omitempty"`
	TaskID         string `json:"task_id,omitempty"`
	UserID         string `json:"user_id,omitempty"`
	Position       string `json:"position,omitempty"`
	Username       string `json:"username,omitempty"`
	Name           any    `json:"name,omitempty"`
	TimerStartDate int    `json:"timer_start_date,omitempty"`
	StatusName     string `json:"status_name,omitempty"`
	IsTimerStarted bool   `json:"is_timer_started,omitempty"`
}

type Task

type Task struct {
	ID                  int    `json:"id,omitempty"`
	Title               string `json:"title,omitempty"`
	Description         string `json:"description,omitempty"`
	DateCreation        int    `json:"date_creation,omitempty"`
	DateCompleted       any    `json:"date_completed,omitempty"`
	DateDue             int    `json:"date_due,omitempty"`
	ColorID             string `json:"color_id,omitempty"`
	ProjectID           int    `json:"project_id,omitempty"`
	ColumnID            int    `json:"column_id,omitempty"`
	OwnerID             int    `json:"owner_id,omitempty"`
	Position            int    `json:"position,omitempty"`
	Score               int    `json:"score,omitempty"`
	IsActive            int    `json:"is_active,omitempty"`
	CategoryID          int    `json:"category_id,omitempty"`
	CreatorID           int    `json:"creator_id,omitempty"`
	DateModification    int    `json:"date_modification,omitempty"`
	Reference           string `json:"reference,omitempty"`
	DateStarted         int    `json:"date_started,omitempty"`
	TimeSpent           any    `json:"time_spent,omitempty"`
	TimeEstimated       any    `json:"time_estimated,omitempty"`
	SwimlaneID          int    `json:"swimlane_id,omitempty"`
	DateMoved           int    `json:"date_moved,omitempty"`
	RecurrenceStatus    int    `json:"recurrence_status,omitempty"`
	RecurrenceTrigger   int    `json:"recurrence_trigger,omitempty"`
	RecurrenceFactor    int    `json:"recurrence_factor,omitempty"`
	RecurrenceTimeframe any    `json:"recurrence_timeframe,omitempty"`
	RecurrenceBasedate  int    `json:"recurrence_basedate,omitempty"`
	RecurrenceParent    any    `json:"recurrence_parent,omitempty"`
	RecurrenceChild     any    `json:"recurrence_child,omitempty"`
	Priority            int    `json:"priority,omitempty"`
	ExternalProvider    any    `json:"external_provider,omitempty"`
	ExternalURI         any    `json:"external_uri,omitempty"`
	CategoryName        any    `json:"category_name,omitempty"`
	SwimlaneName        string `json:"swimlane_name,omitempty"`
	ProjectName         string `json:"project_name,omitempty"`
	ColumnTitle         string `json:"column_title,omitempty"`
	AssigneeUsername    string `json:"assignee_username,omitempty"`
	AssigneeName        any    `json:"assignee_name,omitempty"`
	CreatorUsername     string `json:"creator_username,omitempty"`
	CreatorName         any    `json:"creator_name,omitempty"`
	CategoryDescription any    `json:"category_description,omitempty"`
	ColumnPosition      int    `json:"column_position,omitempty"`
	Tags                []any  `json:"tags,omitempty"`
}

type TaskClose

type TaskClose struct {
	TaskId int  `json:"task_id,omitempty"`
	Task   Task `json:"task,omitempty"`
}

type TaskLink

type TaskLink struct {
	ID             string `json:"id,omitempty"`
	OppositeTaskID string `json:"opposite_task_id,omitempty"`
	TaskID         string `json:"task_id,omitempty"`
	LinkID         string `json:"link_id,omitempty"`
	Label          string `json:"label,omitempty"`
	OppositeLinkID string `json:"opposite_link_id,omitempty"`
}