com.gemalto.idp.mobile.oob.notification

Interface OobNotificationManager

public interface OobNotificationManager

The manager that provides functionality to manage a user notification profile. A notification profile is a list of OobNotificationProfile objects. Each notification profile contains a channel (SMS, Push, email, etc.) and an end point attached to that channel (for example an email address for the case of an email channel).

Since:

4.0

Method Summary

Modifier and Type	Method and Description
OobResponse	clearNotificationProfiles() Clears (remove all) the current client notification profiles.
void	clearNotificationProfiles(OobClearNotificationProfileCallback callback) Clears (remove all) the current client notification profiles.
void	clearNotificationProfiles(OobClearNotificationProfileCallback callback, OobRequestParameter requestParameter) Clears (remove all) the current client notification profiles.
OobResponse	clearNotificationProfiles(OobRequestParameter requestParameter) Sets the notification profile of the current client to the given list.
OobNotificationProfilesResponse	getNotificationProfiles() Retrieves the notification profile from the server, which contains the list of all notification end point associated with the current client.
void	getNotificationProfiles(OobGetNotificationProfileCallback callback) Retrieves the notification profile (the list of all notification profiles associated with the current client) from the server.
void	getNotificationProfiles(OobGetNotificationProfileCallback callback, OobRequestParameter requestParameter) Retrieves the notification profile (the list of all notification profiles associated with the current client) from the server.
OobNotificationProfilesResponse	getNotificationProfiles(OobRequestParameter requestParameter) Retrieves the notification profile from the server, which contains the list of all notification end point associated with the current client.
OobResponse	setNotificationProfiles(List<OobNotificationProfile> notificationProfiles) Sets the notification profile of the current client to the given list.
OobResponse	setNotificationProfiles(List<OobNotificationProfile> notificationProfiles, OobRequestParameter requestParameter) Sets the notification profile of the current client to the given list.
void	setNotificationProfiles(List<OobNotificationProfile> notificationProfiles, OobSetNotificationProfileCallback callback) Sets the notification profile of the current client to the given list.
void	setNotificationProfiles(List<OobNotificationProfile> notificationProfiles, OobSetNotificationProfileCallback callback, OobRequestParameter oobRequestParameter) Sets the notification profile of the current client to the given list.

Method Detail

getNotificationProfiles

OobNotificationProfilesResponse getNotificationProfiles()

Retrieves the notification profile from the server, which contains the list of all notification end point associated with the current client.

This method is long running and should not be executed on the UI thread.

Returns:

The list of profiles associated with the current client.

getNotificationProfiles

OobNotificationProfilesResponse getNotificationProfiles(OobRequestParameter requestParameter)

Retrieves the notification profile from the server, which contains the list of all notification end point associated with the current client.

This method is long running and should not be executed on the UI thread.

Parameters:

requestParameter - The request object carrying all the data required by the OOBS in order to register the user to it.

Returns:

The list of profiles associated with the current client.

Throws:

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

Since:

4.7

setNotificationProfiles

OobResponse setNotificationProfiles(List<OobNotificationProfile> notificationProfiles)

Sets the notification profile of the current client to the given list. If a previous profile was already set, it will be replaced with this new list. If a null list is provided, the notification profile will be cleared.

This method is long running and should not be executed on the UI thread.

Parameters:

notificationProfiles - a list of one or more notification profiles to set as the new notification profile. Setting this to null is equivalent to calling clearNotificationProfiles().

Returns:

result of the request.

setNotificationProfiles

OobResponse setNotificationProfiles(List<OobNotificationProfile> notificationProfiles,
                                    OobRequestParameter requestParameter)

Sets the notification profile of the current client to the given list. If a previous profile was already set, it will be replaced with this new list. If a null list is provided, the notification profile will be cleared.

This method is long running and should not be executed on the UI thread.

Parameters:

notificationProfiles - The list of one or more notification profiles to set as the new notification profile. Setting this to null is equivalent to calling clearNotificationProfiles() or clearNotificationProfiles(OobRequestParameter).

requestParameter - Request object carrying all the data required by the OOBS in order to register the user to it.

Returns:

Result of the request.

Throws:

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

Since:

4.7

clearNotificationProfiles

OobResponse clearNotificationProfiles()

Clears (remove all) the current client notification profiles. This will leaves the client with no notification profile.

This method is long running and should not be executed on the UI thread.

Returns:

result of the request.

clearNotificationProfiles

OobResponse clearNotificationProfiles(OobRequestParameter requestParameter)

Sets the notification profile of the current client to the given list. If a previous profile was already set, it will be replaced with this new list. If a null list is provided, the notification profile will be cleared.

This method is long running and should not be executed on the UI thread.

Parameters:

requestParameter - Request object carrying the custom header.

Returns:

Result of the request.

Throws:

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

Since:

4.7

getNotificationProfiles

void getNotificationProfiles(OobGetNotificationProfileCallback callback)

Retrieves the notification profile (the list of all notification profiles associated with the current client) from the server.

This method is executed asynchronously and the result will be posted in the provided callback interface. The callback will be done in the UI thread.

Parameters:

callback - The object that will be use to post the result to the UI thread.

getNotificationProfiles

void getNotificationProfiles(OobGetNotificationProfileCallback callback,
                             OobRequestParameter requestParameter)

Retrieves the notification profile (the list of all notification profiles associated with the current client) from the server.

This method is executed asynchronously and the result will be posted in the provided callback interface. The callback will be done in the UI thread.

Parameters:

callback - The object that will be use to post the result to the UI thread.

requestParameter - Request object carrying the custom header.

Throws:

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

Since:

4.7

setNotificationProfiles

void setNotificationProfiles(List<OobNotificationProfile> notificationProfiles,
                             OobSetNotificationProfileCallback callback)

Sets the notification profile of the current client to the given list. If a previous profile was already set, it will be replaced with this new

This method is executed asynchronously and the result will be posted in the provided callback interface. The callback will be done in the UI thread. If a null list is provided, the notification profile will be cleared.

Parameters:

notificationProfiles - A list of one ore more notification profiles to set. Setting this to null is equivalent to calling or {@link #clearNotificationProfiles(OobRequestParameter)}.

callback - The object that will be use to post the result to the UI thread.

setNotificationProfiles

void setNotificationProfiles(List<OobNotificationProfile> notificationProfiles,
                             OobSetNotificationProfileCallback callback,
                             OobRequestParameter oobRequestParameter)

Sets the notification profile of the current client to the given list. If a previous profile was already set, it will be replaced with this new

This method is executed asynchronously and the result will be posted in the provided callback interface. The callback will be done in the UI thread. If a null list is provided, the notification profile will be cleared.

Parameters:

notificationProfiles - A list of one ore more notification profiles to set. Setting this to null is equivalent to calling or {@link #clearNotificationProfiles(OobRequestParameter)}.

callback - The object that will be use to post the result to the UI thread.

oobRequestParameter - Request object carrying the custom header.

Throws:

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

Since:

4.7

clearNotificationProfiles

void clearNotificationProfiles(OobClearNotificationProfileCallback callback)

Clears (remove all) the current client notification profiles. This will leaves the client with no notification profile.

This method is executed asynchronously and the result will be posted in the provided callback interface. The callback will be done in the UI thread.

Parameters:

callback - The object that will be use to post the result to the UI thread.

clearNotificationProfiles

void clearNotificationProfiles(OobClearNotificationProfileCallback callback,
                               OobRequestParameter requestParameter)

Clears (remove all) the current client notification profiles. This will leaves the client with no notification profile.

This method is executed asynchronously and the result will be posted in the provided callback interface. The callback will be done in the UI thread.

Parameters:

callback - The object that will be use to post the result to the UI thread.

requestParameter - Request object carrying the custom header.

Throws:

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

Since:

4.7