doc_settings: Document metadata

In cloudyr/rscribd: Scribd API Client Package for R

Description

Retrieve or update document metadata settings

Usage

doc_settings(doc, ...)

doc_change(doc, isbn = NULL, title = NULL, description = NULL,
           access = NULL, license = NULL,
           category = NULL, tags = NULL, fmt = NULL,
           author = NULL, publisher = NULL, 
           pub_date = NULL, edition = NULL,
           disable_select_text = NULL, disable_related = NULL, ...)

Arguments

doc	A document id (or object of class “scribd_doc”) to retrieve.
isbn	Optionally, a character string containing an ISBN number.
title	Optionally, a character string containing a document title.
description	Optionally, a character string containing a document description.
access	Optionally, a character string containing one of “public” or “private”.
license	Optionally, a character string containing a license abbreviation. One of: “by”, “by-nc”, “by-nc-nd”, “by-nc-sa”, “by-nd”, “by-sa”, “c” (copyright), or “pd” (public domain).
category	Optionally, a document category (possibly retrieved from |link{docs_categories}).
tags	Optionally, a character string of comma-separated document tags or a character vector of tags.
fmt	Optionally, a character string of comma-separated formats or a character vector of formats. Only allowed formats are: “pdf”, “txt”, and “original”.
author	Optionally, a character string containing an author name.
publisher	Optionally, a character string containing a publisher name.
pub_date	Optionally, a character string containing a publication date.
edition	Optionally, a character string containing an edition.
disable_select_text	Optionally, a boolean that, if TRUE, prevents users from selecting text in the document on Scribd. Default is FALSE.
disable_related	Optionally, a boolean that, if TRUE, hides the “related documents” panel on Scribd. Default is FALSE.
...	Other arguments passed to HTTP request functions.

Details

doc_settings returns document settings and metadata. doc_change updates those settings and metadata. To retrieve view and download statistics, use doc_stats and to download a document itself use doc.

Value

A list object of class “scribd_doc”.

Author(s)

Thomas J. Leeper

References

API Reference: getSettings

API Reference: changeSettings

See Also

doc, doc_stats, doc_delete

doc_upload, upload_thumbnail

Examples

## Not run: 
mydoc <- "document_id"
doc_settings(mydoc)
doc_change(mydoc, title = "New Title", edition = "2")

## End(Not run)

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