delete_resource: Delete Resources

Description Usage Arguments Details Value Examples

View source: R/delete_resource.R

Description

Delete resources via Trello API.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
delete_resource(
  resource,
  id = NULL,
  path = NULL,
  token = NULL,
  on.error = c("stop", "warn", "message"),
  verbose = FALSE,
  handle = NULL,
  encode,
  response
)

Arguments

resource, id

Resource name (eg. "card") and id.

path

Path (optional).

token

An object of class "Trello_API_token", a path or NULL.

  • If a Token, it is passed as is.

  • If NULL and a cache file called ".httr-oauth" exists, the newest token is read from it. If the file is not found, an error is thrown.

  • If a character vector of length 1, it will be used as an alternative path to the cache file.

on.error

Behavior when HTTP status >= 300, defaults to "stop".

verbose

Whether to pass httr::verbose() to httr::RETRY().

handle

Passed to httr::RETRY().

encode, response

Deprecated.

Details

See Trello API reference for more info about DELETE requests.

Value

See response.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
## Not run: 

# Get token with write access
key = Sys.getenv("MY_TRELLO_KEY")
secret = Sys.getenv("MY_TRELLO_SECRET")

token = get_token("my_app", key = key, secret = secret,
                  scope = c("read", "write"))

# Get board ID
url = "Your board URL"
bid = get_id_board(url, token)

# Get cards and extract ID of the first one
cid = get_board_cards(bid, token)$id[1]

# Delete it
delete_resource(resource = "card", id = cid, token = token)

## End(Not run)

trelloR documentation built on April 22, 2021, 1:07 a.m.