FacebookEventsCollection: Build a collection of Facebook events
In theclue/facebook.S4: Access to Facebook API V2 via a Set of S4 Classes

Description Usage Arguments Details Value Nesting fields Valid sources Author(s) See Also Examples

Connect to Facebook Graph API, get information from a list of Facebook events and build a FacebookEventsCollection-class instance.

FacebookEventsCollection(id, token = NULL, parameters = list(),
  fields = c("id", "owner.fields(id,name)", "category", "description",
  "end_time", "attending_count", "declined_count", "maybe_count",
  "noreply_count", "interested_count"),
  n = getOption("facebook.maxitems"), metadata = FALSE,
  .progress = create_progress_bar(), stop.condition = function(x) {    
  FALSE })

`id`	A character vector or a comma-delimited string of IDs or an existing Facebook Collection of any of the supported types (see below).
`token`	Either a temporary access token created at https://developers.facebook.com/tools/explorer or the OAuth token created with `fbOAuth`. If token `NULL` and `id` is a collection, use the token of the source collection. Otherwise, no query is performed to the Facebook Graph API and an empty collection is returned.
`parameters`	A list of parameters to be added to the Facebook Graph API query. For more information on the accepted parameters, see: https://developers.facebook.com/docs/graph-api/using-graph-api.
`fields`	A character vector with the fields to get for each `id`. If no value for a given field is found, it will be set to `NULL`.
`n`	If `id` is an iterable collection, then `n` is the maximum number of events to be pulled for each element of the source collection in `id`. It can be set to `Inf` to pull out any available event and assumes the default value from the value of `facebook.maxitems` global option if missing. If `id` is not a collection or cannot be iterated, the parameter is ignored.
`metadata`	If set to `TRUE`, the metadata for each ID is pulled with the data and the `type` slot is fed accordingly. Please note that setting this to `TRUE` could considerably slow down the execution time, as more queries are needed.
`.progress`	progress_bar object as defined in the plyr package. By default the `none` progress bar is used, which prints nothing to the console. See create_progress_bar for details.
`stop.condition`	anonymous function that is executed for each element of the collection, passed to the function as a list called 'x'. If the function returns `TRUE`, the execution of the query will end up at the end of the current page (even if more pages of data are available). By default, this function will always return `FALSE`.

FacebookEventsCollection is the constructor for the FacebookEventsCollection-class. It returns metadata about events but doesn't return the list of attenders by default.

A collection of events in a FacebookEventsCollection-class object.

Due to the network-graph nature of Facebook data model, you can specify fields details for each field nesting .fields() clauses.

For example, if you need only id and source for the cover field, this is valid among others: cover.fields(id,source).

Following the same philosophy, if you need only id and name for the from node you can use from.fields(id,name).

Instead of a character vector, one of these collections can also be passed as parameter in id:

FacebookUsersCollection-class will build a collection with the events of the users in the source collection. By default, only the attending events are returned, but this behaviour can be changed using the type=(attending|created|declined|maybe|not_replied) parameter.
FacebookPagesCollection-class will build a collection with the events linked to the pages in the source collection.
FacebookGroupsCollection-class will build a collection with the events linked to the groups in the source collection.

Gabriele Baldassarre https://gabrielebaldassarre.com

FacebookGroupsCollection, FacebookPagesCollection

Other Facebook Collection Constructors: FacebookAlbumsCollection, FacebookCommentsCollection, FacebookConversationsCollection, FacebookGroupsCollection, FacebookLikesCollection, FacebookMessagesCollection, FacebookPagesCollection, FacebookPhotosCollection, FacebookPostsCollection, FacebookReactionsCollection, FacebookUsersCollection, FacebookVideosCollection

## Not run: 
## See examples for fbOAuth to know how token was created.
 load("fb_oauth")
 
## Getting information about two example Facebook Pages
 fb.pages <- FacebookPagesCollection(id = c("9thcirclegames",
                                           "NathanNeverSergioBonelliEditore"), 
                                     token = fb_oauth)
 
## Pull at most 10 albums from each page
 fb.events <- FacebookEventscollection(id = fb.pages, token = fb_oauth, n = 10)
 

## End(Not run)