Skip to content

Commit 3aaf94c

Browse files
committed
Fix google calendar query node documentation. Closes #71.
1 parent 6c285af commit 3aaf94c

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

google/calendar.html

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,31 @@
3030
</script>
3131

3232
<script type="text/x-red" data-help-name="google calendar">
33-
<p>Create an entry in a <a href="https://www.google.com/calendar">Google Calendar</a>.</p>
33+
<p>Return the next event in a <a href="https://www.google.com/calendar">Google Calendar</a>.</p>
3434
<p>The incoming message can provide the following properties:
3535
<ul>
36-
<li><b>payload</b> - an object containing the query parameters described in <a href="https://developers.google.com/google-apps/calendar/v3/reference/events/list">event list API documentation</a></li>
37-
<li><b>calendar</b> - the calendar to add the event to (optional, defaults to the node calendar property or the users primary calendar)</li>
36+
<li><b>payload</b> - a text search string used to select relevant events</li>
37+
<li><b>calendar</b> - the calendar to retrieve the event from (optional, defaults to the node calendar property or the users primary calendar)</li>
38+
</ul>
39+
</p>
40+
<p>The message sent from the node will have properties:
41+
<ul>
42+
<li><b>title</b> - the summary string from the calendar entry</li>
43+
<li><b>description</b> - the description from the calendar entry</li>
44+
<li><b>location.description</b> - the location string from the calendar entry</li>
45+
<li><b>data</b> - the raw event from the google calendar query as described in the <a href="https://developers.google.com/google-apps/calendar/v3/reference/events/list">event list API documentation</a></li>
46+
<li><b>payload</b> - an object containing:
47+
<ul>
48+
<li><b>title</b> - the summary string from the calendar entry</li>
49+
<li><b>description</b> - the description from the calendar entry</li>
50+
<li><b>location.description</b> - the location string from the calendar entry</li>
51+
<li><b>start</b> - Javascript Date of start time - midnight for all day event</li>
52+
<li><b>end</b> - Javascript Date of end time - midnight for all day event</li>
53+
<li><b>allDayEvent</b> - true if event is an all day event</li>
54+
<li><b>creator</b> - object containing name and email properties</li>
55+
<li><b>attendees</b> - list of objects containing name and email properties</li>
56+
</ul>
57+
</li>
3858
</ul>
3959
</p>
4060
</script>

0 commit comments

Comments
 (0)