Gini Health SDK for Android/net.gini.android.health.sdk/GiniHealth

GiniHealth

public final class GiniHealth

GiniHealth is one of the main classes for interacting with the Gini Health SDK. It manages interaction with the Gini Health API.

documentFlow, paymentFlow, openBankState are used by the ReviewFragment to observe their state, but they are public so that they can be observed anywhere, the main purpose for this is to observe errors.

Constructors

GiniHealth

public GiniHealth GiniHealth(GiniHealthAPI giniHealthAPI)

Types

Companion

public class Companion

PaymentState

public class PaymentState

Functions

checkIfDocumentContainsMultipleDocuments

public final Boolean checkIfDocumentContainsMultipleDocuments(String documentId)

Checks whether the invoice contains multiple documents by fetching the invoice and its extractions from the Gini Pay API and verifying whether it has multiple documents or not.

checkIfDocumentIsPayable

public final Boolean checkIfDocumentIsPayable(String documentId)

Checks whether the document is payable by fetching the document and its extractions from the Gini Pay API and verifying that the extraction's payment state is "Payable".

getDocumentFlow

public final StateFlow<ResultWrapper<Document>> getDocumentFlow()

A flow for getting the Document set for review setDocumentForReview.

getGiniHealthAPI

public final GiniHealthAPI getGiniHealthAPI()

getOpenBankState

public final StateFlow<GiniHealth.PaymentState> getOpenBankState()

A flow that exposes the state of opening the bank. You can collect this flow to get information about the errors of this action.

getPaymentFlow

public final StateFlow<ResultWrapper<PaymentDetails>> getPaymentFlow()

A flow for getting extracted PaymentDetails for the document set for review (see setDocumentForReview).

setDocumentForReview

public final Unit setDocumentForReview(Document document)

public final Unit setDocumentForReview(String documentId, PaymentDetails paymentDetails)

Sets a Document for review. Results can be collected from documentFlow and paymentFlow.

setSavedStateRegistryOwner

public final Unit setSavedStateRegistryOwner(SavedStateRegistryOwner registryOwner, CoroutineScope retryScope)

Sets a lifecycle observer to handle state restoration after the system kills the app.

setSDKLanguage

public final Unit setSDKLanguage(GiniLocalization language, Context context)

Sets the app language to the desired one from the languages the SDK is supporting. If not set then defaults to the system's language locale.

Properties

documentFlow

private final StateFlow<ResultWrapper<Document>> documentFlow

A flow for getting the Document set for review setDocumentForReview.

giniHealthAPI

private final GiniHealthAPI giniHealthAPI

openBankState

private final StateFlow<GiniHealth.PaymentState> openBankState

A flow that exposes the state of opening the bank. You can collect this flow to get information about the errors of this action.

paymentFlow

private final StateFlow<ResultWrapper<PaymentDetails>> paymentFlow

A flow for getting extracted PaymentDetails for the document set for review (see setDocumentForReview).