Package com.onfido

Class ReportManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.ReportManager

public class ReportManager
extends ResourceManager

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	cancel(String reportId)	Cancels single paused reports.
Report	find(String reportId)	Retrieves a single report.
List<Report>	list(String checkId)	Lists all reports belonging to a particular check.
void	resume(String reportId)	Resumes a single paused report.

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

ReportManager

protected ReportManager(Config config,
                        okhttp3.OkHttpClient client)

Method Detail

find

public Report find(String reportId)
            throws OnfidoException

Retrieves a single report.

Parameters:

reportId - the report id

Returns:

the Report

Throws:

OnfidoException - the onfido exception

list

public List<Report> list(String checkId)
                  throws OnfidoException

Lists all reports belonging to a particular check.

Parameters:

checkId - the check id

Returns:

the list of Reports

Throws:

OnfidoException - the onfido exception

resume

public void resume(String reportId)
            throws OnfidoException

Resumes a single paused report. If successful, returns a 204 No Content response.

Parameters:

reportId - the report id

Throws:

OnfidoException - the onfido exception

cancel

public void cancel(String reportId)
            throws OnfidoException

Cancels single paused reports. If successful, returns a 204 No Content response.

Parameters:

reportId - the report id

Throws:

OnfidoException - the onfido exception