gc_event_ls: List events in calendar

In benjcunningham/googlecalendar: Google Calendar for R

Description

Lists events scheduled on a Google Calendar. This method filters information made available via the Google Calendar API Events resource.

Usage

gc_event_ls(x, ..., verbose = FALSE)

Arguments

x	A googlecalendar object representing the calendar for which to list events.
verbose	Logical indicating whether to print informative messages.
...	Additional parameters to be passed as part of the HTTP request to the API. More information on these named arguments are available below.

Details

An arbitrary number of optional query parameters may be supplied via .... A list of optional query 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).

Note that event_ls objects only represent resource properties that are naturally atomic. To fetch all properties for an event, use gc_event. For more information on the structure of an event_ls object, see the Google Calendar API Events Resource Overview.

Value

An event_ls object (a custom class wrapping a tbl_df) with one row for each event returned by the service.

Examples

## Not run: 
gc_summary("Commitments") %>%
  gc_event_ls()

## End(Not run)

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