gc_ls: List calendars a user can view and modify

In benjcunningham/googlecalendar: Google Calendar for R

Description

Lists the collection of calendars in the user's calendar list. This method filters information made available in the Google Calendar API CalendarList resource.

Usage

gc_ls(pattern = NULL, ..., verbose = TRUE)

Arguments

pattern	Character string containing a regular expression (or exact character string for fixed = TRUE) to be matched to the calendar title field, summary. If non-NULL, only matching calendars will be returned.
verbose	Logical indicating whether to print informative messages.
...	Optional arguments to be passed to grep.

Details

Note that calendar_ls objects only represent resource properties that are naturally atomic. To fetch all properties for a calendar, use gc_calendar. For more information on the structure of a calendar_ls object, see the Google Calendar API

Calendar lists may only give a partial view of the calendars available to the user. Calendars represented in a list are a subset of available calendars where Show in List has been selected in Calendar Settings.

Value

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

Examples

## Not run: 
gc_ls()

gc_ls("ts$")
gc_ls("commitments", ignore.case = TRUE)
gc_ls("Commitments", fixed = TRUE)

## End(Not run)

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