Package com.onfido

Class WorkflowRunManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.WorkflowRunManager

public class WorkflowRunManager
extends ResourceManager

Manager class for the WorkflowRun resource type. Contains resource-specific methods for interacting with the API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WorkflowRunManager(Config config, okhttp3.OkHttpClient client)

Method Summary

Modifier and Type	Method	Description
WorkflowRun	create(WorkflowRun.Request request)	Create a workflow run.
FileDownload	evidence(String workflowRunId)	Downloads a Workflow Run signed evidence file.
WorkflowRun	find(String workflowRunId)	Retrieves a single WorkflowRun.

Methods inherited from class com.onfido.api.ResourceManager

addFormDataParam, deleteRequest, downloadRequest, get, post, put, readInputStream, uploadRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowRunManager

protected WorkflowRunManager(Config config,
                             okhttp3.OkHttpClient client)

Method Detail

create

public WorkflowRun create(WorkflowRun.Request request)
                   throws OnfidoException

Create a workflow run.

Parameters:

request - the request body

Returns:

the WorkflowRun

Throws:

OnfidoException - the onfido exception

find

public WorkflowRun find(String workflowRunId)
                 throws OnfidoException

Retrieves a single WorkflowRun.

Parameters:

workflowRunId - the workflow run id

Returns:

the WorkflowRun

Throws:

OnfidoException - the onfido exception

evidence

public FileDownload evidence(String workflowRunId)
                      throws OnfidoException

Downloads a Workflow Run signed evidence file.

Parameters:

workflowRunId - the workflow run id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception