Package lumis.portal.mobileapp

Class MobileAPIV10

java.lang.Object

lumis.portal.mobileapp.MobileAPIV10

@StableMinor(version="14.1",
             sinceVersion="10.0")
@Path("/mobile/v1.0")
public class MobileAPIV10
extends Object

Mobile API version 1.0.

Since:

10.0.0

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

Field Summary

Fields

Modifier and Type	Field	Description
static String	VERSION

Constructor Summary

Constructors

Constructor	Description
MobileAPIV10()

Method Summary

Modifier and Type	Method	Description
protected String	getGCMProjectId()	Returns the GCM project identifier.
protected String	getLoginRedirectURL()	Returns the after-login redirect URL or null if there's none.
String	getWebsiteInfo()
Response	keepAlive()	Endpoint to keep user's session alive.
Response	mobileLogin(String login, String password)	Login operation targeted to mobile devices.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

MobileAPIV10

public MobileAPIV10()

Method Detail

mobileLogin

@POST
@Path("/authentication/login")
@Produces("application/json")
public Response mobileLogin(@FormParam("login") @NotNull
                            String login,
                            @FormParam("password")
                            String password)
                     throws Exception

Login operation targeted to mobile devices. Besides the login operation, returns the user config.

Parameters:

login - the login.

password - the password.

Returns:

the response, which will be one of:

• Response code 200 with the user config, if the login operation succeeded
• Response code 422, if the login operation failed
• Response code 500, if an error occurred

Throws:

Exception

Since:

10.0.0

getLoginRedirectURL

protected String getLoginRedirectURL()

Returns the after-login redirect URL or null if there's none.

Returns:

the after-login redirect URL or null if there's none.

Since:

10.0.0

getGCMProjectId

protected String getGCMProjectId()
                          throws PortalException

Returns the GCM project identifier.

Returns:

the GCM project identifier.

Throws:

PortalException

Since:

10.0.0

getWebsiteInfo

@Path("/website/info")
@GET
@Produces("application/json")
public String getWebsiteInfo()
                      throws Exception

Throws:

Exception

keepAlive

@Path("/session/keepalive")
@GET
@Produces("application/json")
public Response keepAlive()
                   throws Exception

Endpoint to keep user's session alive.

Returns:

the response.

Throws:

Exception

Since:

10.0.0