zz_delete: Delete file from Zamzar account

Description Usage Arguments Details Value Examples

View source: R/zz_delete.R

Description

Delete file from Zamzar account provided a file id.

Usage

1
zz_delete(id = NULL, usr = NULL, verbose = FALSE)

Arguments

id

The target id for a file you wish to delete. Most likely returned from ‘zz get info()‘.

usr

The username/API key you are using. If not set, the function will check if a key exists as a 'ZAMZAR_USR' variable in '.Renviron' and use that.

See: https://developers.zamzar.com/user

verbose

Boolean deciding whether or not verbose status messages should be returned. Defaults to 'FALSE'.

Details

Please note that a Zamzar key passed as argument to 'usr' takes precedence over a Zamzar key extracted from an '.Renviron'.

Value

A status message indicating either success or failure.

Examples

1
2
3
4
5
6
## Not run: 
# An example of zz_delete() with a hardcoded file id

zz_get(id = 12345678)

## End(Not run)

zzlite documentation built on March 26, 2020, 7:36 p.m.