gc_calendar: Retrieve a calendar

Description Usage Arguments Details Value Examples

Description

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

Usage

1
2
3
gc_id(x, verbose = TRUE)

gc_summary(x, fixed = FALSE, ..., verbose = TRUE)

Arguments

x

Calendar-identifying information. For gc_id, a calendar ID as a character string. For gc_summary, a regular expression to be matched to the calendar title field, summary.

verbose

Logical indicating whether to print informative messages.

fixed

Logical indicating whether x should be matched literally.

...

Optional arguments to be passed to grep.

Details

While the Google Calendar API prefers to return sparse structures, googlecalendar objects attempt to faithfully represent all documented fields in the CalendarList resource. In practice, this means that values unreported by the service are reported as NA or, if applicable, their documented default values.

For more information on the structure of a googlecalendar object, see the Google Calendar API CalendarList Resource Overview.

Value

Calendar metadata as a googlecalendar object (a custom class wrapping a named list).

Examples

1
2
3
4
5
6
7
8
## Not run: 
gc_id("kpoji8n345cid1eu6o0mlcbs30@group.calendar.google.com")

gc_summary("ments$")
gc_summary("commitments", ignore.case = TRUE)
gc_summary("Commitments", fixed = TRUE)

## End(Not run)

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