ino_stream_contents: Returns the articles for a given collection

Description Usage Arguments Value References

View source: R/stream-contents.R

Description

Returns the articles for a given collection

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
ino_stream_contents(
  stream_id,
  num_items = 20L,
  order = c("newest", "oldest"),
  start_time = (Sys.time() - 604800),
  exclude = NULL,
  include = NULL,
  continuation = NULL,
  all = TRUE,
  annotations = FALSE
)

Arguments

num_items

Number of items to return (default 20, max 1000). If the value passed is less than zero or greater than one thousand, 20 and 1000 will be used (respectively).

order

Order. By default, it is newest first. You can pass oldest here to get oldest first.

start_time

Start time (POSIXct or a string that can be converted to POSIXct) from which to start to get items. Defaults to 7 days ago.

exclude

Exclude Target — You can query all items from a feed that are not flagged as read by setting this to user/-/state/com.google/read. Default is NULL.

include

Include Target — You can query for a certain label with this. Accepted values: (e.g.) user/-/state/com.google/starred, user/-/state/com.google/like. Default is NULL.

continuation

Continuation (default NULL) — a string used for continuation process. Each response returns not all, but only a certain number of items. Pass the continuation value of the returned list (if one exists) to retrieve the next part of the result set. If there is no continuation value, there are no more feed items left.

all
  • set this to FALSE (default is TRUE) if you want to receive only manually added tags in the categories list. Otherwise automatically added tags from the folders will be populated there too.

annotations
  • set this to TRUE (default is FALSE) if you want to get an array of your annotations for each article.

Value

list with metadata about the result and result items in the item slot. See linked reference for field information.

References

Stream contents


hrbrmstr/inoreadr documentation built on Jan. 1, 2022, 12:14 a.m.