Google Calendar

godoc

import "barista.run/modules/gsuite/calendar"

Show upcoming events: calendar.New(/* client config */).

Shows upcoming events on a Google Calendar. It uses the standard oauth package.

Configuration

• Output(func(events EventList) bar.Output): Sets the output format.

• RefreshInterval(time.Duration): Sets the refresh interval. Defaults to 10 minutes. This is only the interval at which new events are downloaded. The output can change more frequently based on the start/end/alert times of the last fetched events.

• TimeWindow(time.Duration): Controls how far in the the future events should be loaded from. Defaults to 18 hours.

• CalendarID(string): The calendar ID to fetch events from. Defaults to "primary".

• ShowDeclined(bool): If true, include declined events; If false (default), remove declined events from all event lists.

Example

Cal: 2h10m

Cal: -0h5m

Show time until the next event, refreshed every minute:

calendar.New().Output(func(evts calendar.EventList) bar.Output {
	var e calendar.Event
	switch {
	case len(evts.InProgress) > 0:
		e = evts.InProgress[0]
	case len(evts.Alerting) > 0:
		e = evts.Alerting[0]
	case len(evts.Upcoming) > 0:
		e = evts.Upcoming[0]
	default:
		return nil
	}
	untilStart := e.UntilStart()
	minus := ""
	if untilStart < 0 {
		untilStart = -untilStart
		minus = "-"
	}
	return outputs.Repeat(func(time.Time) bar.Output {
		return outputs.Textf("Cal: %s%dh%dm",
			minus, int(untilStart.Hours()), int(untilStart.Minutes())%60)
	}).Every(time.Minute)
})

Data: type EventList struct

Fields

• InProgress []Event: All events currently in progress.
• Alerting []Event: Events where the time until start is less than the notification duration. The notification duration is merged from the calendar default and any event-specific settings, using the earliest "popup".
• Upcoming []Event: All other future events (limited by TimeWindow).

type Event struct

• Start time.Time: Start time of the event
• End time.Time: End time of the event
• Alert time.Time: Time at which a notification should be shown. Same as Start if no alerts are configured. This is the earliest "popup" alert configured for the event (or the calendar if no alerts are configured for the event specifically).
• EventStatus Status: Status of the event (not your response)
• Response Status: Your response to the event
• Location string: Location of the event
• Summary string: Summary of the event

Methods

• UntilStart() time.Duration: Time remaining (or since) the start of the event.
• UntilEnd() time.Duration: Time remaining (or since) the end of the event.
• UntilAlert() time.Duration: Time remaining (or since) the earliest "popup" notification for this event.