user_watchlist: Get a user's watchlist

View source: R/user_watchlist.R

user_watchlistR Documentation

Get a user's watchlist

Description

Get a user's watchlist

Usage

user_watchlist(
  user = getOption("trakt_username"),
  type = c("movies", "shows"),
  extended = c("min", "full")
)

Arguments

user

character(1): Target username (or slug). Defaults to getOption("trakt_username"). Can also be of length greater than 1, in which case the function is called on all user values separately and the result is combined.

type

character(1): Either "shows" or "movies". For season/episode-specific functions, values seasons or episodes are also allowed.

extended

character(1): Either "min" (API default) or "full". The latter returns more variables and should generally only be used if required. See vignette("finding-things") for more details.

Value

A tibble(). If the function has a limit parameter (defaulting to 10), this will be the (maximum) number of rows of the tibble. If there are no results (or the API is unreachable), an empty tibble() is returned.

Source

user_watchlist() wraps endpoint users/:id/watchlist/:type.

See Also

Other user data: user_collection(), user_comments(), user_history(), user_likes(), user_network(), user_profile(), user_ratings(), user_stats(), user_watched()

Examples

## Not run: 
# Defaults to movie watchlist and minimal info
user_watchlist(user = "sean")

## End(Not run)

jemus42/tRakt documentation built on May 4, 2024, 9:21 a.m.