RP_APIWaitForJobCompletion: RP_APIWaitForJobCompletion

RP_APIWaitForJobCompletionR Documentation

RP_APIWaitForJobCompletion

Description

Waits until the request file is available to download

Usage

RP_APIWaitForJobCompletion(APIHandler, token, 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.

timeout

Time (in seconds) to wait.

Value

The final status of the job. A list containg two values: STATUS (String defining the final status: 'completed', 'error' or 'timeout'), and STATUSINFO status object coming from RP_APICheckFileAvailability().

Author(s)

Maria Gomez


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