ztr_read_items: Read (Top-Level) Items In The Library, Excluding Trashed...

In tellnnn/ztr4r: Zotero API and tools for R

Description

Read (Top-Level) Items In The Library, Excluding Trashed Items

Usage

ztr_read_items(
  zotero_object,
  collection = NULL,
  top = FALSE,
  ...,
  timeout = 20
)

Arguments

zotero_object	Zotero object.
collection	Collection key. If specified, items within a specific collection will be retrieved.
top	Item level (default: FALSE): FALSE: All the items in the library, excluding trashed items TRUE : Top-level items in the library, excluding trashed items
...	Query inputs. See Read Requests, Searching, and Sorting and Pagination in the Zotero Web API Documents for available query.
timeout	Seconds for the timeout of request (default: 20).

Value

httr::response object

Examples

## Not run: 
ztr <- Zotero$new("ztr4r")

# simple example
ztr %>%
  ztr_read_items()

# example with query: All the items in the library, excluding trashed items
ztr %>%
  ztr_read_items(
    collection = NULL, top = TRUE,
    format = "json", sort = "dateModified", direction = "asc", limit = 25, start = 0
  )

# example with query: Top-level items in the library, excluding trashed items.
ztr %>%
  ztr_read_items(
    collection = "foo", top = TRUE,
    format = "json", sort = "dateModified", direction = "asc", limit = 25, start = 0
  )

## End(Not run)

tellnnn/ztr4r documentation built on Dec. 23, 2021, 8:43 a.m.