gc_event: Retrieve a calendar event

In benjcunningham/googlecalendar: Google Calendar for R

Description

Retrieves metadata for a Google Calendar event in the form of an event object. This method filters information made available through the Google Calendar API Events resource.

Usage

gc_event_query(x, ..., verbose = TRUE)

gc_event_id(x, id, verbose = TRUE)

Arguments

x	googlecalendar object representing the calendar for where the event resides.
verbose	Logical indicating whether to print informative messages.
id	Event ID as a character string.
...	Additional parameters to be passed as part of the HTTP request. More information on these optional values is available below.

Details

For gc_event_query, an arbitrary number of optional query parameters may be supplied via .... A list of available parameters can be found in Events: List.

Notable parameters include:

• q – Free text search terms to find in any field.

• singleEvents – Logical indicating whether to expand recurring events into instances and only return single one-off events.

• timeMax – Exclusive upper bound of the start time filter (formatted as an RFC3339 timestamp).

• timeMin – Inclusive lower bound of the end time filter (formatted as an RFC3339 timestamp).

For more information on the structure of an event object, see the Google Calendar API Events Resource Overview.

Value

Event metadata as an event object (a custom class wrapping a named list).

Examples

## Not run: 
gc_summary("Commitments") %>%
  gc_event_id("lohlv4duqhqu8bh6kfok9ookmk")

gc_summary("Commitments") %>%
  gc_event_query(cal, q = "Lunch with Will")

## End(Not run)

benjcunningham/googlecalendar documentation built on May 12, 2019, 11:56 a.m.