Create a list

Usage

bs_new_list(
  name,
  purpose,
  description,
  avatar,
  user = get_bluesky_user(),
  pass = get_bluesky_pass(),
  auth = bs_auth(user, pass),
  clean = TRUE
)

Arguments

name: Character. Display name for list.
purpose: Purpose of the list. One of 'modlist', 'curatelist', or 'referencelist'
description: Optional character. Description of the list.
avatar: Optional character. Path to image to use as avatar. PNG or JPEG recommended.
user: Character. User name to log in with. Defaults to get_bluesky_user().
pass: Character. App password to log in with. Defaults to get_bluesky_pass().
auth: Authentication information. Defaults to bs_auth(user, pass).
clean: Logical. Should output be cleaned into a tibble? Default: TRUE.

Value

a tibble::tibble of list information

Lexicon references

graph/list.json (2024-12-01) graph/defs.json (2024-12-01) repo/createRecord.json (2023-11-25)

Function introduced

v0.2.0 (2024-12-01)

Examples

if (FALSE) { # has_bluesky_pass() && has_bluesky_user()
bs_new_list(name = 'test list bskyr', purpose = 'curatelist')
bs_new_list(name = 'test list bskyr w avatar',
  description = 'to be deleted, just for testing bskyr',
  avatar = fs::path_package('bskyr', 'man/figures/logo.png'),
  purpose = 'curatelist')
}