collections: Collections

Description Usage Arguments Details Value Author(s) See Also Examples

Description

View collections and documents in a collection

Usage

1
2
3
coll_list(access = NULL, ...)

coll_docs(id, limit = 20, offset = 0, ...)

Arguments

access

Restrict response to an access level for the collection; one of “public” or “private”.

id

A collection id (or object of class “scribd_collection”), the documents from which you want to retrieve.

limit

For results pagination, a numeric value indicating the number of result to return. Must be less than 1000.

offset

For results pagination, a numeric value indicating the initial result to return. Must be less than 1000.

...

Other arguments passed to HTTP request functions.

Details

coll_list returns a list of collections available to the user.

coll_docs returns a list of documents contained in a collection. Results can be paginated using the limit (page size) and offset (page start) parameters. For example, a call with limit = 20, offset = 0 returns the first 20 results. A subsequent call to limit = 20, offset = 20 returns the next 20 results.

Value

For coll_list, a list of objects of class “scribd_collection”. For coll_docs, a list of objects of class “scribd_doc”.

Author(s)

Thomas J. Leeper

See Also

coll_create, coll_update, coll_delete

coll_add, coll_remove

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# my public documents
coll_list("public")

# my private documents
privatecolls <- coll_list("private")
coll_docs(privatecolls[[1]])

## End(Not run)

cloudyr/rscribd documentation built on May 13, 2019, 8:22 p.m.