Package org.cyclos.services.mobile

Interface InternalMobileService

All Superinterfaces:

Service

All Known Subinterfaces:

InternalMobileServiceLocal

public interface InternalMobileService
extends Service

This service returns data used by the REST api for the mobile app

Field Summary

Fields

Modifier and Type	Field	Description
static String	MOBILE_RECAPTCHA	Path to the mobile reCaptcha url.
static String	MOBILE_REDIRECT	Path to the mobile redirect url.

Method Summary

Modifier and Type	Method	Description
String	generateLinkForMobile(String urlFilePart)	Generates a link to be opened by the Mobile Application for the given Url file part. E.g cyclos://forgotPassword?key=ZBCXYZ
MobileGuestData	getGuestData(GetMobileGuestDataParams params)	Returns data for mobile when in guest mode (before logging in).
String	getRecaptchaKey()	Returns the Recaptcha key for the current configuration
MobileUserData	getUserData(GetMobileUserDataParams params)	Returns data for mobile when in user mode (either logged in or connected via POS).

Field Detail

MOBILE_REDIRECT

static final String MOBILE_REDIRECT

Path to the mobile redirect url.

See Also:

Constant Field Values

MOBILE_RECAPTCHA

static final String MOBILE_RECAPTCHA

Path to the mobile reCaptcha url.

See Also:

Constant Field Values

Method Detail

generateLinkForMobile

String generateLinkForMobile(String urlFilePart)

Generates a link to be opened by the Mobile Application for the given Url file part.
E.g cyclos://forgotPassword?key=ZBCXYZ

getGuestData

MobileGuestData getGuestData(GetMobileGuestDataParams params)
                      throws FrameworkException

Returns data for mobile when in guest mode (before logging in). The theme will be returned by its components: base definitions, advanced definitions and custom style.

Parameters:

params - Parameters for getting mobile guest data:
deviceId (Optional) the trusted device id to query if it's still exists. pinLocator (Optional) the device pin locator to query if it's still exists and has not expired. onlyCustomizedTranslations Whether to return only customized translations in case translations must be returned

Throws:

FrameworkException

getRecaptchaKey

String getRecaptchaKey()

Returns the Recaptcha key for the current configuration

getUserData

MobileUserData getUserData(GetMobileUserDataParams params)
                    throws FrameworkException

Returns data for mobile when in user mode (either logged in or connected via POS). The theme will be returned by its components: base definitions, advanced definitions and custom style.

Parameters:

params - Parameters for getting mobile user data:
onlyCustomizedTranslations Whether to return only customized translations in case translations must be returned

Throws:

FrameworkException