get_hash_status: Retrieve Information for the hash calculated from an R object...

In rkrug/ROriginStamp: Interface to OriginStamp API to Obtain Trusted Time Stamps

Retrieve Information for the hash calculated from an R object or file.

Description

Wrapper around https://api.originstamp.com/swagger/swagger-ui.html#/timestamp/getHashStatus

Usage

get_hash_status(x, error_on_fail = TRUE, url = api_url(), key = api_key())

Arguments

x	an R object (character vector containing file names of existing files or strings) of which a hash will be calculated using the function hash(x). The resulting hash will be submitted to OriginStamp.
error_on_fail	if TRUE, raise error when api call fails, otherwise return the failed response.
url	the url of the api. The default is to use the url as returned by the function api_url()
key	the api key. The default is to use the key as returned by the function api_key()

Details

The behavior depends on the class of the argument x:

• an object of class hash as returned by the package openssl: the hash is submitted to OriginStamp

• character vector of length 1 containing the name of an existing file: the hash of the file is calculated and submitted to OriginStamp

• any other R object: the hash is calculated using the function hash() and submitted to OriginStamp

Value

object of type OriginStampResponse, content contains the additional info as list.

Examples

## Not run: 
# get hash info
x <- "2c5d36be542f8f0e7345d77753a5d7ea61a443ba6a9a86bb060332ad56dba38e"
class(x) <- "hash"
get_hash_status(
  x = x
)

get_hash_status(x = letters)

## End(Not run)

rkrug/ROriginStamp documentation built on Aug. 16, 2022, 5:45 p.m.