FacebookMessagesCollection: Build a collection of Facebook inbox messages
In facebook.S4: Access to Facebook API V2 via a Set of S4 Classes

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

View source: R/FacebookMessagesCollection.R

Connect to Facebook Graph API, get information from a list of inbox messages and build a FacebookMessagesCollection-class instance.

FacebookMessagesCollection(id, token = NULL, parameters = list(),
  fields = c("id", "from", "created_time", "message"),
  n = getOption("facebook.maxitems"), metadata = FALSE,
  .progress = create_progress_bar())

`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 conversations to be pulled for each element of the source collection in `id`. It can be set to `Inf` to pull out any available conversation 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.

FacebookMessagesCollection is the constructor for the FacebookMessagesCollection-class. It returns data about inbox messages between users or users and pages.

A collection of messages in a FacebookMessagesCollection-class object.

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

FacebookConversationsCollection-class will build a collection with all the messages from the given conversations. A page access token with read_page_mailboxes is needed to read the related mailboxes user access token with read_mailbox is needed to perform this action, in case of conversations between users.

Gabriele Baldassarre https://gabrielebaldassarre.com

FacebookConversationsCollection, facebook.participants, facebook.senders

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

## Not run: 
## See examples for fbOAuth to know how token was created.
 load("fb_page_oauth")
 
## Getting the messages of the first conversation of an example page.
## A page access token is needed to access the inbox
 messages <- FacebookPagesCollection("9thcirclegames", fb_page_oauth) %>%
             FacebookConversationsCollection(n = 1) %>%
             FacebookMessagesCollection()

## End(Not run)