memo

Documentation

Overview

Package memo is about doing a simple TODO list-like task

Index

• Variables
• type BasicInfo
• type Board
• type Item
• type Memo

Variables

var MemoAPI *core.API

MemoAPI for Memo

Types

type BasicInfo

type BasicInfo struct {
	Title       string `json:"title,omitempty" bson:"title,omitempty"`
	Description string `json:"description,omitempty" bson:"description,omitempty"`
}

BasicInfo provide simple information about Memo entities

type Board

type Board struct {
	ID                 primitive.ObjectID `json:"id" bson:"_id"`
	BasicInfo          `bson:",inline"`
	Access             int    `json:"access" bson:"access"`
	Memos              []Memo `json:"memos,omitempty" bson:"memos,omitempty"`
	core.TrackedEntity `bson:",inline"`
}

Board is a memo container

type Item

type Item struct {
	Text       string    `json:"text" bson:"text"`
	IsFinished bool      `json:"isFinished,omitempty" bson:"isFinished"`
	DueDate    time.Time `json:"dueDate,omitempty" bson:"dueDate,omitempty"`
}

Item is a single action or thing to remember

type Memo

type Memo struct {
	ID                 primitive.ObjectID `json:"id" bson:"_id"`
	BasicInfo          `bson:",inline"`
	Items              []Item `json:"items,omitempty" bson:"items"`
	core.TrackedEntity `bson:",inline"`
}

Memo is a group of items to be remembered. Comparing to a manual TODO list or checklist, a memo would be a single page