FragmentFlowListener (sdk 1.0.0 API)

java.lang.Object
- com.wallee.android.sdk.fragment.FragmentFlowListener<T>

Type Parameters:

T - the type of the fragment which is modified by this listener.

All Implemented Interfaces:

FlowListener, OnApiErrorListener, OnBeforeLoadingPaymentMethodListener, OnErrorListener, OnHttpErrorListener, OnNetworkErrorListener, OnPaymentContainerResizeListener, OnPaymentFormValidationListener, OnPaymentFormViewReadyListener, OnTokenSelectedListener, OnTokenSelectionViewReady, OnTransactionFailureListener, OnTransactionSuccessListener
```
public class FragmentFlowListener<T extends AbstractPaymentFragment>
extends java.lang.Object
implements OnTokenSelectionViewReady, OnErrorListener, OnPaymentFormValidationListener, OnPaymentFormViewReadyListener, OnPaymentContainerResizeListener, OnTransactionSuccessListener, OnTransactionFailureListener, OnTokenSelectedListener, OnBeforeLoadingPaymentMethodListener
```
The fragment flow listener maps the events triggered by FlowCoordinator to the fragment. This class may be overridden to realize a custom behavior of the fragment.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FragmentFlowListener(T fragment, PaymentContainerEnlarger enlarger, FragmentTerminationListener fragmentTerminationListener, android.view.ViewGroup fragmentView)` This method creates a new listener.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected android.content.Context`	`getContext()`
`protected android.widget.Button`	`getFormSubmitButton()`
`protected T`	`getFragment()`
`protected android.view.ViewGroup`	`getFragmentView()`
`protected android.widget.Button`	`getOtherPaymentMethodButton()`
`protected PaymentContainerEnlarger`	`getPaymentContainerEnlarger()`
`void`	`onBeforeLoadingPaymentMethod()` This method is invoked before the payment method list is loaded.
`void`	`onClientError(ClientError error)` This method is invoked when there was a client error.
`void`	`onHttpError(HttpError error)` This method is invoked when there occurred a HTTP error.
`void`	`onNetworkError(VolleyError error)` This methdo is invoked when the communication between the mobile device and the wallee API fails.
`void`	`onPaymentContainerEnlarge()` This method is invoked when the provided view should be enlarged to render more complex content (e.g.
`void`	`onPaymentContainerReduce()` This method is called when the view size can be reduced again.
`void`	`onPaymentFormViewReady(boolean userInputRequired)` This method is invoked when the payment form is ready.
`void`	`onServerError(ServerError error)` This method is invoked when there was an error which was caused by a bug within the wallee platform itself.
`void`	`onTokenSelected(TokenVersion selectedTokenVersion)` This method is invoked when the user has chosen a token with which the payment should be completed with.
`void`	`onTokenSelectionViewReady()` This method is invoked when the payment method selection view is loaded.
`void`	`onTransactionFailure(Transaction transaction, FailureReason failureReason, java.lang.String userFailureMessage)` This method is invoked when the transaction is considered as failed.
`void`	`onTransactionSuccess(Transaction transaction)` This method is called when the `transaction` is considered as successful.
`void`	`onValidationFailure(java.util.List<java.lang.String> errors)` This method is invoked when the validation fails.
`void`	`onValidationSuccess()` This method is invoked when the validation completed without errors.
`protected void`	`runOnUiThread(java.lang.Runnable task)` Short cut for `Activity.runOnUiThread(Runnable)`.
`void`	`setFlowCoordinator(FlowCoordinator coordinator)` Sets the coordinator.
`protected android.widget.Button`	`setupFormSubmitButton()` This method setups a button which triggers the submit of the payment form.
`protected android.widget.Button`	`setupOtherPaymentMethodButton()` This method setups a button which triggers the switch form the token selection view to the payment method selection view.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FragmentFlowListener
```
protected FragmentFlowListener(T fragment,
                               PaymentContainerEnlarger enlarger,
                               FragmentTerminationListener fragmentTerminationListener,
                               android.view.ViewGroup fragmentView)
```
    This method creates a new listener.
    
    Parameters:
    
    fragment - the fragment onto which the events should be mapped to.
    
    enlarger - the enlarge to use. The enlarge is responsible to enlarge the fragment when more space is required.
    
    fragmentTerminationListener - the listener which acts up on the final state of the payment flow.
    
    fragmentView - the view of the fragment which can be modified.
- Method Detail
  - setFlowCoordinator
```
public final void setFlowCoordinator(FlowCoordinator coordinator)
```
    Sets the coordinator. We cannot set the coordinator in the constructor because we need the listener to create the coordinator.
    
    Parameters:
    
    coordinator - the coordinator
  - getFragment
```
protected T getFragment()
```
    Returns:
    
    the fragment which is modified by this listener.
  - getPaymentContainerEnlarger
```
protected PaymentContainerEnlarger getPaymentContainerEnlarger()
```
    Returns:
    
    the fragment enlarger which is used.
  - getContext
```
protected android.content.Context getContext()
```
    Returns:
    
    the android context in which the listener is executed in.
  - runOnUiThread
```
protected void runOnUiThread(java.lang.Runnable task)
```
    Short cut for Activity.runOnUiThread(Runnable).
    
    Parameters:
    
    task - the task which should be executed in the main thread.
  - getFormSubmitButton
```
protected final android.widget.Button getFormSubmitButton()
```
    Returns:
    
    the button which triggers the submit.
  - getOtherPaymentMethodButton
```
protected final android.widget.Button getOtherPaymentMethodButton()
```
    Returns:
    
    the button which triggers a switch from the token list to the payment method selection list.
  - getFragmentView
```
protected android.view.ViewGroup getFragmentView()
```
    Returns:
    
    the view which holds the whole fragment.
  - setupFormSubmitButton
```
protected android.widget.Button setupFormSubmitButton()
```
    This method setups a button which triggers the submit of the payment form.
    
    Returns:
    
    the submit button to use.
  - setupOtherPaymentMethodButton
```
protected android.widget.Button setupOtherPaymentMethodButton()
```
    This method setups a button which triggers the switch form the token selection view to the payment method selection view.
    
    Returns:
    
    the button which should be used to switch to the payment method selection view.
  - onValidationFailure
```
public void onValidationFailure(java.util.List<java.lang.String> errors)
```
    Description copied from interface: OnPaymentFormValidationListener
    
    This method is invoked when the validation fails.
    
    Specified by:
    
    onValidationFailure in interface OnPaymentFormValidationListener
    
    Parameters:
    
    errors - a list of error messages which may give more details about the failure.
  - onValidationSuccess
```
public void onValidationSuccess()
```
    Description copied from interface: OnPaymentFormValidationListener
    
    This method is invoked when the validation completed without errors.
    
    Specified by:
    
    onValidationSuccess in interface OnPaymentFormValidationListener
  - onNetworkError
```
public void onNetworkError(VolleyError error)
```
    Description copied from interface: OnNetworkErrorListener
    
    This methdo is invoked when the communication between the mobile device and the wallee API fails.
    
    Specified by:
    
    onNetworkError in interface OnNetworkErrorListener
    
    Parameters:
    
    error - the error which has been thrown. It may gives more details about what went wrong.
  - onClientError
```
public void onClientError(ClientError error)
```
    Description copied from interface: OnApiErrorListener
    
    This method is invoked when there was a client error. For example the user has provided an invalid card number or the invocation fails because somehow the service was used in a wrong way.
    So client error means that either the app user, the developer which invokes the web service API or the user which configured the space has done something wrong.
    
    Specified by:
    
    onClientError in interface OnApiErrorListener
    
    Parameters:
    
    error - the error which may gives more details about the issue.
  - onServerError
```
public void onServerError(ServerError error)
```
    Description copied from interface: OnApiErrorListener
    
    This method is invoked when there was an error which was caused by a bug within the wallee platform itself. The error references a UUID which can be provided to the support to fix the issue. This method may be invoked also when the user has done something wrong, but the handling inside the platform of the misbehavior is not handled properly (which is also a bug).
    
    Specified by:
    
    onServerError in interface OnApiErrorListener
    
    Parameters:
    
    error - the error which gives more details about the failure.
  - onTokenSelectionViewReady
```
public void onTokenSelectionViewReady()
```
    Description copied from interface: OnTokenSelectionViewReady
    
    This method is invoked when the payment method selection view is loaded.
    
    Specified by:
    
    onTokenSelectionViewReady in interface OnTokenSelectionViewReady
  - onPaymentFormViewReady
```
public void onPaymentFormViewReady(boolean userInputRequired)
```
    Description copied from interface: OnPaymentFormViewReadyListener
    
    This method is invoked when the payment form is ready. This means the payment form is fully loaded and the user may enter some data.
    
    Specified by:
    
    onPaymentFormViewReady in interface OnPaymentFormViewReadyListener
  - onHttpError
```
public void onHttpError(HttpError error)
```
    Description copied from interface: OnHttpErrorListener
    
    This method is invoked when there occurred a HTTP error. This happens typically within a WebView.
    
    Specified by:
    
    onHttpError in interface OnHttpErrorListener
    
    Parameters:
    
    error - the error which was thrown.
  - onPaymentContainerEnlarge
```
public void onPaymentContainerEnlarge()
```
    Description copied from interface: OnPaymentContainerResizeListener
    
    This method is invoked when the provided view should be enlarged to render more complex content (e.g. the 3-D secure authorization form).
    
    Specified by:
    
    onPaymentContainerEnlarge in interface OnPaymentContainerResizeListener
  - onPaymentContainerReduce
```
public void onPaymentContainerReduce()
```
    Description copied from interface: OnPaymentContainerResizeListener
    
    This method is called when the view size can be reduced again.
    
    Specified by:
    
    onPaymentContainerReduce in interface OnPaymentContainerResizeListener
  - onTransactionSuccess
```
public void onTransactionSuccess(Transaction transaction)
```
    Description copied from interface: OnTransactionSuccessListener
    
    This method is called when the transaction is considered as successful.
    Be aware if someone is decompile the app this method can be also invoked. There is no guarantee that the invocation of this method is secured. Means someone can trigger it even the transaction is not successful. As such any action taken within this method it should only affect the user interface. To enable something or to grant something a webhook should be used to inform the app backend. So with other words: The implementor of this listener should not trigger something in the app backend. This should be done through a webhook.
    
    Specified by:
    
    onTransactionSuccess in interface OnTransactionSuccessListener
    
    Parameters:
    
    transaction - the transaction which succeeds.
  - onTransactionFailure
```
public void onTransactionFailure(Transaction transaction,
                                 FailureReason failureReason,
                                 java.lang.String userFailureMessage)
```
    Description copied from interface: OnTransactionFailureListener
    
    This method is invoked when the transaction is considered as failed. This can happen for various reasons. The userFailureMessage provides in any case a message localized to the language of the user which explains to the app user what is going on.
    The failureReason gives an explanation to the merchant resp. app developer. This message may be logged. It can be also seen in the back office of wallee.
    
    The implementor of this method may trigger a specific behavior in case of a failure. For example switch to a dedicated view which explains it.
    
    Specified by:
    
    onTransactionFailure in interface OnTransactionFailureListener
    
    Parameters:
    
    transaction - the transaction which failed.
    
    failureReason - the reason which explains to the merchant what went wrong. This message may also help the app developer to understand what is going wrong.
    
    userFailureMessage - this message is localized in the app user's language. It gives a user friendly explanation what is going wrong.
  - onTokenSelected
```
public void onTokenSelected(TokenVersion selectedTokenVersion)
```
    Description copied from interface: OnTokenSelectedListener
    
    This method is invoked when the user has chosen a token with which the payment should be completed with.
    
    Specified by:
    
    onTokenSelected in interface OnTokenSelectedListener
    
    Parameters:
    
    selectedTokenVersion - the token which has been selected by the user to complete the transaction with.
  - onBeforeLoadingPaymentMethod
```
public void onBeforeLoadingPaymentMethod()
```
    Description copied from interface: OnBeforeLoadingPaymentMethodListener
    
    This method is invoked before the payment method list is loaded.
    
    Specified by:
    
    onBeforeLoadingPaymentMethod in interface OnBeforeLoadingPaymentMethodListener

Class FragmentFlowListener<T extends AbstractPaymentFragment>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FragmentFlowListener

Method Detail

setFlowCoordinator

getFragment

getPaymentContainerEnlarger

getContext

runOnUiThread

getFormSubmitButton

getOtherPaymentMethodButton

getFragmentView

setupFormSubmitButton

setupOtherPaymentMethodButton

onValidationFailure

onValidationSuccess

onNetworkError

onClientError

onServerError

onTokenSelectionViewReady

onPaymentFormViewReady

onHttpError

onPaymentContainerEnlarge

onPaymentContainerReduce

onTransactionSuccess

onTransactionFailure

onTokenSelected

onBeforeLoadingPaymentMethod