aboutsummaryrefslogtreecommitdiff
path: root/schedule.go
diff options
context:
space:
mode:
authorCollin Guarino <collin.guarino@gmail.com>2016-02-14 18:57:56 -0500
committerCollin Guarino <collin.guarino@gmail.com>2016-02-14 18:57:56 -0500
commitee75d43f6f19a295531323d22d035bc9fcabc289 (patch)
treea4d3010ca764c57f2756f4a625a7888c4cc37a67 /schedule.go
parent476acf944f7f859a5ad2e7003f82d3f96fbff1a5 (diff)
Added documentation for Bridge.GetSchedules and Schedule struct.
Diffstat (limited to 'schedule.go')
-rw-r--r--schedule.go2
1 files changed, 2 insertions, 0 deletions
diff --git a/schedule.go b/schedule.go
index 43c7056..c7c2690 100644
--- a/schedule.go
+++ b/schedule.go
@@ -12,6 +12,7 @@ import (
"encoding/json"
)
+// Schedule struct defines attributes of Alarms and Timers
type Schedule struct {
Name string `json:"name"`
Description string `json:"description"`
@@ -30,6 +31,7 @@ type Schedule struct {
ID string
}
+// Bridge.GetSchedules will get Alarms and Timers in a Schedule struct.
func (bridge *Bridge) GetSchedules() ([]Schedule, error) {
uri := fmt.Sprintf("/api/%s/schedules", bridge.Username)
body, _, err := bridge.Get(uri)