R/dashboard_activity_list.R

In ropensci/ckanr: Client for the Comprehensive Knowledge Archive Network ('CKAN') API

#' Authorized user's dashboard activity stream
#'
#' @export
#'
#' @param limit (integer) The maximum number of activities to return (optional).
#' Default: 31
#' @param offset (integer) Where to start getting activity items from (optional).
#' Default: 0
#' @template args
#' @template key
#'
#' @examples \dontrun{
#' # Setup
#' ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
#'
#' # get activity
#' (res <- dashboard_activity_list())
#' }
dashboard_activity_list <- function(limit = 31, offset = 0,
  url = get_default_url(), key = get_default_key(), as = 'list', ...) {

  args <- list(limit = limit, offset = offset)
  res <- ckan_GET(url, 'dashboard_activity_list', args, key = key,
    opts = list(...))
  switch(as, json = res, list = jsl(res), table = jsd(res))
}