Package lumis.portal.mobileapp

Class MobileAPIV10

  • @StableMinor(version="17.0",
             sinceVersion="10.0")
@Path("/mobile/v1.0")
public class MobileAPIV10
extends java.lang.Object
    Mobile API version 1.0.
    Since:
    10.0.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String VERSION  

    • Constructor Summary

      Constructors 
      Constructor Description
      MobileAPIV10()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.String getGCMProjectId()
      Returns the GCM project identifier.
      protected java.lang.String getLoginRedirectURL()
      Returns the after-login redirect URL or null if there's none.
      java.lang.String getWebsiteInfo()  
      Response keepAlive()
      Endpoint to keep user's session alive.
      Response mobileLogin​(@NotNull java.lang.String login, java.lang.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

    • Constructor Detail

      • MobileAPIV10

        public MobileAPIV10()

    • Method Detail

      • mobileLogin

        @POST
@Path("/authentication/login")
@Produces("application/json")
public Response mobileLogin​(@FormParam("login") @NotNull
                            @NotNull java.lang.String login,
                            @FormParam("password")
                            java.lang.String password)
                     throws java.lang.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:
        java.lang.Exception
        Since:
        10.0.0

      • getLoginRedirectURL

        protected java.lang.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 java.lang.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 java.lang.String getWebsiteInfo()
                                throws java.lang.Exception
        Throws:
        java.lang.Exception

      • keepAlive

        @Path("/session/keepalive")
@GET
@Produces("application/json")
public Response keepAlive()
                   throws java.lang.Exception
        Endpoint to keep user's session alive.
        Returns:
        the response.
        Throws:
        java.lang.Exception
        Since:
        10.0.0