Class MobileAPIV10


  • @StableMinor(version="14.2",
                 sinceVersion="10.0")
    @Path("/mobile/v1.0")
    public class MobileAPIV10
    extends Object
    Mobile API version 1.0.
    Since:
    10.0.0
    Version:
    $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $
    • Constructor Detail

      • MobileAPIV10

        public MobileAPIV10()
    • Method Detail

      • mobileLogin

        @POST
        @Path("/authentication/login")
        @Produces("application/json")
        public Response mobileLogin​(@FormParam("login") @NotNull
                                    @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