Comment Display Screenlet for Android

Requirements

  • Android SDK 4.0 (API Level 15) or above
  • Liferay Portal 6.2 (CE or EE), Liferay 7.0 CE, Liferay DXP
  • Liferay Screens Compatibility plugin (for Liferay Portal CE or Liferay Portal EE).

Compatibility

  • Android SDK 4.0 (API Level 15) and above

Xamarin Requirements

  • Visual Studio 7.2
  • Mono .NET framework 5.4.1.6

Features

Comment Display Screenlet can show one comment of an asset in a Liferay instance. It also lets the user update or delete the comment.

JSON Services Used

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

Service Method Notes
ScreenscommentService (Screens compatibility plugin) getComment
ScreenscommentService (Screens compatibility plugin) updateComment
CommentmanagerjsonwsService deleteComment

Module

  • None

Views

  • Default

The Default View uses User Portrait Screenlet, and TextView and ImageButton elements to show an asset’s comment. Other Views may different components to show the comment.

screens-android-commentdisplay.png

Figure 1: Comment Display Screenlet using the Default View.

Offline

This Screenlet supports offline mode so it can function without a network connection. For more information on how offline mode works, see the tutorial on its architecture. Here are the offline mode policies that you can use with this Screenlet:

Policy What happens When to use
REMOTE_ONLY The Screenlet loads the data from the Liferay instance. If a connection issue occurs, the Screenlet uses the listener to notify the developer about the error. If the Screenlet successfully loads the data, it stores it in the local cache for later use. Use this policy when you always need to show updated data, and show nothing when there’s no connection.
CACHE_ONLY The Screenlet loads the data from the local cache. If the data isn’t there, the Screenlet uses the listener to notify the developer about the error. Use this policy when you always need to show local data, without retrieving remote information under any circumstance.
REMOTE_FIRST The Screenlet loads the data from the Liferay instance. If this succeeds, the Screenlet shows the data to the user and stores it in the local cache for later use. If a connection issue occurs, the Screenlet retrieves the data from the local cache. If the data doesn’t exist there, the Screenlet uses the listener to notify the developer about the error. Use this policy to show the most recent version of the data when connected, but show an outdated version when there’s no connection.
CACHE_FIRST The Screenlet loads the data from the local cache. If the data isn’t there, the Screenlet requests it from the Liferay instance and notifies the developer about any errors that occur (including connectivity errors). Use this policy to save bandwidth and loading time in case you have local (but probably outdated) data.

Required Attributes

  • commentId

Attributes

Attribute Data type Explanation
layoutId @layout The layout to use to show the View.
autoLoad boolean Whether the list should automatically load when the Screenlet appears in the app’s UI. The default value is true.
cachePolicy string The offline mode setting. See the Offline section for details.
commentId number The primary key of the comment to display.
editable boolean Whether the user can edit the comment.

Methods

Method Return Explanation
load() void Starts the request to load the comment.

Listener

Comment Display Screenlet delegates some events to a class that implements CommentDisplayListener. This interface lets you implement the following methods:

  • onLoadCommentSuccess(CommentEntry commentEntry): Called when the Screenlet successfully loads the comment.

  • onDeleteCommentSuccess(CommentEntry commentEntry): Called when the Screenlet successfully deletes the comment.

  • onUpdateCommentSuccess(CommentEntry commentEntry): Called when the Screenlet successfully updates the comment.

  • error(Exception e, String userAction): Called when an error occurs in the process. The userAction argument distinguishes the specific action in which the error occurred.

0 (0 Votes)
Comment List Screenlet for Android Previous