Comment List Screenlet for iOS

Requirements

• Xcode 9.3 or above
• iOS 11 SDK
• Liferay Portal 6.2 CE/EE, Liferay CE Portal 7.0/7.1, Liferay DXP 7.0+
• Liferay Screens Compatibility app (CE or EE/DXP). This app is preinstalled in Liferay CE Portal 7.0/7.1 and Liferay DXP 7.0+.

Compatibility

• iOS 9 and above

Xamarin Requirements

• Visual Studio 7.2
• Mono .NET framework 5.4.1.6

Features

Comment List Screenlet can list all the comments of an asset in a Liferay instance. It also lets the user update or delete comments.

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)	getCommentsWithClassName
ScreenscommentService (Screens compatibility plugin)	getCommentsCount

Module

• None

Themes

• Default

The Default Theme uses an iOS UITableView to show an asset’s comments. Other Themes may use a different component, such as iOS’s UICollectionView or others, to show the items.

Figure 1: Comment List Screenlet using the Default Theme.

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 list from the Liferay instance. If a connection issue occurs, the Screenlet uses the delegate to notify the developer about the error. If the Screenlet successfully loads the list, it stores the data 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 list from the local cache. If the list isn’t there, the Screenlet uses the delegate 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 list from the Liferay instance. If this succeeds, the Screenlet shows the list to the user and stores it in the local cache for later use. If a connection issue occurs, the Screenlet retrieves the list from the local cache. If the list doesn’t exist there, the Screenlet uses the delegate to notify the developer about the error.	Use this policy to show the most recent version of the data when connected, but show a possibly outdated version when there’s no connection.
cache-first	The Screenlet loads the list from the local cache. If the list 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 possibly outdated) data.

Required Attributes

• className
• classPK

Attributes

Attribute	Data type	Explanation
className	string	The asset’s fully qualified class name. For example, a blog entry’s className is com.liferay.blogs.kernel.model.BlogsEntry. The className and classPK attributes are required to instantiate the Screenlet.
classPK	number	The asset’s unique identifier. The className and classPK attributes are required to instantiate the Screenlet.
offlinePolicy	string	The offline mode setting. The default is remote-first. See the Offline section for details.
editable	boolean	Whether the user can edit the comment.
autoLoad	boolean	Whether the list should automatically load when the Screenlet appears in the app’s UI. The default value is true.
refreshControl	boolean	Defines whether a standard iOS UIRefreshControl is shown when the user does the pull to refresh gesture. The default value is true.
firstPageSize	number	The number of items retrieved from the server for display on the first page. The default value is 50.
pageSize	number	The number of items retrieved from the server for display on the second and subsequent pages. The default value is 25.
obcClassName	string	The name of the OrderByComparator class to use to sort the results. You can only use classes that extend OrderByComparator<MBMessage>. If you don’t want to sort the results, you can omit this property.

Methods

Method	Return	Explanation
loadList()	boolean	Starts the request to load the list. This list is shown when the response is received. Returns true if the request is sent.

Delegate

Comment List Screenlet delegates some events to an object that conforms to the ComentListScreenletDelegate protocol. This protocol lets you implement the following methods:

• - screenlet:onListResponseComments:: Called when the Screenlet receives the comments.

• - screenlet:onCommentListError:: Called when an error occurs in the process. The NSError object describes the error.

• - screenlet:onSelectedComment:: Called when a comment is selected.

• - screenlet:onDeletedComment:: Called when a comment is deleted.

• - screenlet:onCommentDelete:: Called when the Screenlet prepares a comment for deletion.

• - screenlet:onUpdatedComment:: Called when a comment is updated.

• - screenlet:onCommentUpdate:: Called when the Screenlet prepares a comment for update.