Forgot Password Screenlet for Android

Requirements

  • Android SDK 4.1 (API Level 16) or above
  • Liferay Portal 6.2 CE/EE, Liferay CE Portal 7.0/7.1, Liferay DXP
  • Liferay Screens Compatibility app (CE or EE/DXP). This app is preinstalled in Liferay CE Portal 7.0/7.1 and Liferay DXP.

Compatibility

  • Android SDK 4.1 (API Level 16) or above

Xamarin Requirements

  • Visual Studio 7.2
  • Mono .NET framework 5.4.1.6

Features

The Forgot Password Screenlet sends an email to registered users with their new passwords or password reset links, depending on the server configuration. The available authentication methods are

  • Email address
  • Screen name
  • User id

JSON Services Used

Screenlets in Liferay Screens call JSON web services in the portal. This Screenlet calls the following services and methods.

ServiceMethodNotes
UserServicesendPasswordByEmailAddress
UserServicesendPasswordByUserId
UserServicesendPasswordByScreenName

Module

  • Auth

Views

  • Default
  • Material

The Forgot Password Screenlet with the Default (left) and Material (right) Viewsets.

Portal Configuration

To use Forgot Password Screenlet, the portal must be configured to allow users to request new passwords. The below sections show you how to do this. Also, Liferay Screens’ Compatibility Plugin must be installed.

Authentication Method

The authentication method configured in the portal can be different from the one used by this Screenlet. For example, it’s perfectly fine to use screenName for sign in authentication, but allow users to recover their password using the email authentication method.

Password Reset

You can set the Liferay instance’s corresponding password reset options in the Control Panel by selecting ConfigurationInstance Settings, and then selecting the Authentication section. The Screenlet’s password functionality depends on the authentication settings in the portal:

Checkboxes for the password recovery features in your Liferay instance.

If these options are both unchecked, password recovery is disabled. If both options are checked, an email containing a password reset link is sent when a user requests it. If only the first option is checked, an email containing a new password is sent when a user requests it.

For more details on authentication in Liferay Portal, please refer to the Setting up a Liferay Instance section of the User Guide.

Anonymous Request

An anonymous request can be made without the user being logged in. However, authentication is needed to call the API. To allow this operation, the portal administrator should create a specific user with minimal permissions.

Offline

This Screenlet doesn’t support offline mode. It requires network connectivity.

Required Attributes

  • anonymousApiUserName
  • anonymousApiPassword

Attributes

AttributeData typeExplanation
layoutId@layoutThe layout used to show the View.
anonymousApiUserNamestringThe user name, email address, or userId to use for authenticating the request. This depends on the portal’s authentication settings.
anonymousApiPasswordstringThe password to use to authenticate the request.
companyIdnumberWhen set, a user within the specified company is authenticated. If the value is set to 0, the company specified in LiferayServerContext is used.
basicAuthMethodstringThe authentication method presented to the user. This can be email, screenName, or userId. The default value is email.

Listener

The Forgot Password Screenlet delegates some events to an object that implements the ForgotPasswordListener interface. This interface lets you implement the following methods:

  • onForgotPasswordRequestSuccess(boolean passwordSent): Called when a password reset email is successfully sent. The boolean parameter determines whether the email contains the new password or a password reset link.

  • onForgotPasswordRequestFailure(Exception e): Called when an error occurs in the process.

« Sign Up Screenlet for AndroidUser Portrait Screenlet for Android »
Was this article helpful?
0 out of 0 found this helpful