RP_APIDownloadFileWhenReady: RP_APIDownloadFileWhenReady

RP_APIDownloadFileWhenReadyR Documentation

RP_APIDownloadFileWhenReady

Description

Downloads a request file when it is ready.

Usage

RP_APIDownloadFileWhenReady(APIHandler, token, outputFile, timeout = 60)

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler.

token

A string that identifies the request. Check RP_APIRequestDataFile to generate a request.

outputFile

Output filename.

timeout:

time (in seconds) to wait for download. Default 60.

Value

TRUE if the download was successful. An Error otherwise.

Author(s)

Maria Gomez


RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.