calendar

Documentation

Index

• type ProviderInfo
• type View
  • func GetView(db *sql.DB, user *data.User, location *time.Location, startTime time.Time, ...) (View, error)
• type ViewDay

Types

type ProviderInfo

type ProviderInfo struct {
	Name string `json:"name"`
}

A ProviderInfo struct represents information about an active calendar providers.

type View

type View struct {
	Providers       []ProviderInfo    `json:"providers"`
	SchoolsToUpdate []data.SchoolInfo `json:"schoolsToUpdate"`
	Days            []ViewDay         `json:"days"`
}

A View represents a view of a user's calendar over a certain period of time.

func GetView

func GetView(db *sql.DB, user *data.User, location *time.Location, startTime time.Time, endTime time.Time) (View, error)

GetView retrieves a CalendarView for the given user with the given parameters.

type ViewDay

type ViewDay struct {
	DayString     string                     `json:"day"`
	Announcements []data.PlannerAnnouncement `json:"announcements"`
	Events        []data.Event               `json:"events"`
}

A ViewDay represents a day in a View.