com.gemalto.idp.mobile.oob.registration

Interface OobUnregistrationManager

public interface OobUnregistrationManager

Interface for unregistering the user to the OOBS.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
OobResponse	unregister() Performs the unregistration of the user from the OOBS: The synchronous variant.
OobResponse	unregister(OobRequestParameter requestParameter) Performs the unregistration of the user from the OOB: The synchronous variant.
void	unregister(OobUnregistrationCallback callback) Performs the unregistration of the user to the OOBS: The asynchronous variant.
void	unregister(OobUnregistrationCallback callback, OobRequestParameter requestParameter) Performs the unregistration of the user to the OOBS: The asynchronous variant.

Method Detail

unregister

OobResponse unregister()

Performs the unregistration of the user from the OOBS: The synchronous variant.

Attention:

This method blocks the calling thread potentially for a very long time (like tens of seconds or even more, depending on the quality of the mobile network connection).

When this method is called from within the main UI thread it throws the NetworkOnMainThreadException - as it is very bad habit to obstacle the main UI thread with the blocking calls (the same is done for instance by the Android HTTP library).

Returns:

The unregistration response object, never null.

unregister

OobResponse unregister(OobRequestParameter requestParameter)

Performs the unregistration of the user from the OOB: The synchronous variant.

Attention:

This method blocks the calling thread potentially for a very long time (like tens of seconds or even more, depending on the quality of the mobile network connection).

When this method is called from within the main UI thread it throws the NetworkOnMainThreadException - as it is very bad habit to obstacle the main UI thread with the blocking calls (the same is done for instance by the Android HTTP library).

Parameters:

requestParameter - The request parameter carrying custom header.

Note:

Certain common HTTP headers fields (e.g. Content-Length) are not allowed to be overridden. The list of prohibited headers in the provisioning can be found in the Programmer's Guide.

Returns:

The unregistration response object, never null.

Throws:

IllegalArgumentException - When the collection of headers passed in is null, or adding a header prohibited in the headers customization or containing illegal characters.

unregister

void unregister(OobUnregistrationCallback callback)

Performs the unregistration of the user to the OOBS: The asynchronous variant.

Note:

This method returns control to the caller almost immediately (not blocking call). The completion is notified to the caller via the specified callback.

Parameters:

callback - The callback to be triggered as soon as the operation completes with any result. Must never be null. Note that the callback is always called from within the main UI thread context and always after this method returns to its caller.

unregister

void unregister(OobUnregistrationCallback callback,
                OobRequestParameter requestParameter)

Performs the unregistration of the user to the OOBS: The asynchronous variant.

Note:

This method returns control to the caller almost immediately (not blocking call). The completion is notified to the caller via the specified callback.

Parameters:

callback - The callback to be triggered as soon as the operation completes with any result. Must never be null. Note that the callback is always called from within the main UI thread context and always after this method returns to its caller.

requestParameter - The request parameter carrying custom header.

Note:

Certain common HTTP headers fields (e.g. Content-Length) are not allowed to be overridden. The list of prohibited headers in the provisioning can be found in the Programmer's Guide.