Package com.onfido

Class LivePhotoManager

java.lang.Object

com.onfido.api.ResourceManager

com.onfido.LivePhotoManager

public class LivePhotoManager
extends ResourceManager

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FileDownload	download(String livePhotoId)	Downloads a live photo.
LivePhoto	find(String livePhotoId)	Retrieves a single live photo.
List<LivePhoto>	list(String applicantId)	Lists the live photos that belong to an applicant.
LivePhoto	upload(InputStream inputStream, String fileName, LivePhoto.Request request)	Uploads a live photo as part of a multipart request.

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

LivePhotoManager

protected LivePhotoManager(Config config,
                           okhttp3.OkHttpClient client)

Method Detail

upload

public LivePhoto upload(InputStream inputStream,
                        String fileName,
                        LivePhoto.Request request)
                 throws IOException,
                        OnfidoException

Uploads a live photo as part of a multipart request.

Parameters:

inputStream - the content from the desired file as an InputStream

fileName - the file name, including the file extension

request - the request body

Returns:

the live photo

Throws:

IOException - the io exception

OnfidoException - the onfido exception

download

public FileDownload download(String livePhotoId)
                      throws OnfidoException

Downloads a live photo.

Parameters:

livePhotoId - the live photo id

Returns:

the downloaded file as a FileDownload

Throws:

OnfidoException - the onfido exception

find

public LivePhoto find(String livePhotoId)
               throws OnfidoException

Retrieves a single live photo.

Parameters:

livePhotoId - the live photo id

Returns:

the LivePhoto

Throws:

OnfidoException - the onfido exception

list

public List<LivePhoto> list(String applicantId)
                     throws OnfidoException

Lists the live photos that belong to an applicant.

Parameters:

applicantId - the applicant id

Returns:

the list of LivePhotos

Throws:

OnfidoException - the onfido exception