InternalMobileService (Cyclos 4.15.15 Scripting API Documentation)

All Superinterfaces:

Service

All Known Subinterfaces:

InternalMobileServiceLocal

All Known Implementing Classes:

InternalMobileServiceImpl, InternalMobileServiceSecurity
```
public interface InternalMobileService
extends Service
```
This service returns data used by the REST api for the mobile app

Method Summary

All Methods Instance Methods Abstract Methods
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(Long deviceId, PinLocatorVO pinLocator, GetVersionedDataParams 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).

- 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(Long deviceId,
                             PinLocatorVO pinLocator,
                             GetVersionedDataParams 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:
    
    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.
    
    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.
    
    Throws:
    
    FrameworkException