get_account_favourites: Get favourites of user

View source: R/accounts.R

get_account_favouritesR Documentation

Get favourites of user

Description

Get favourites of user

Usage

get_account_favourites(
  max_id,
  min_id,
  limit = 40L,
  token = NULL,
  parse = TRUE,
  retryonratelimit = TRUE,
  verbose = TRUE
)

Arguments

max_id

character, Return results older than this id

min_id

character, Return results younger than this id

limit

integer, Maximum number of results to return

token

user bearer token (read from file by default)

parse

logical, if TRUE, the default, returns a tibble. Use FALSE to return the "raw" list corresponding to the JSON returned from the Mastodon API.

retryonratelimit

If TRUE, and a rate limit is exhausted, will wait until it refreshes. Most Mastodon rate limits refresh every 5 minutes. If FALSE, and the rate limit is exceeded, the function will terminate early with a warning; you'll still get back all results received up to that point.

verbose

logical whether to display messages

Details

this functions needs a user level auth token. If limit>40, automatic pagination is used. You may get more results than requested.

Value

tibble or list of favourited statuses

Examples

## Not run: 
# needs user level token
get_account_favourites()

## End(Not run)

rtoot documentation built on Nov. 6, 2023, 1:07 a.m.