Web Content 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

Web Content List Screenlet can show lists of web content from a Liferay instance. It can show both basic and structured web content. The Screenlet also implements fluent pagination with configurable page size, and supports i18n in asset values.

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
JournalArticleService	getArticlesWithGroupId
JournalArticleService	getArticlesCount

Module

• WebContent

Themes

• Default

The Default Theme uses a standard UITableView to show the scrollable list. Other Themes may use a different component, such as UICollectionView or others, to show the contents.

Figure 1: Web Content List Screenlet using the Default (`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

• folderId

Attributes

Attribute	Data type	Explanation
groupId	number	The ID of the site (group) where the web content exists. If set to 0, the groupId specified in LiferayServerContext is used. The default value is 0.
folderId	number	The ID of the web content folder. If set to 0, the root folder is used. The default value is 0.
offlinePolicy	string	The offline mode setting. The default value is remote-first. See the Offline section for details.
autoLoad	boolean	Whether the list loads automatically when the Screenlet appears in the app’s UI. The default value is true.
refreshControl	boolean	Whether a standard iOS UIRefreshControl appears when the user does the pull to refresh gesture. The default value is true.
firstPageSize	number	The number of items to display on the first page. The default value is 50.
pageSize	number	The number of items to 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. Omit this property if you don’t want to sort the results. Click here to see some comparator classes. Note, however, that not all of these classes can be used with obcClassName. You can only use comparator classes that extend OrderByComparator<JournalArticle>. You can also create your own comparator classes that extend OrderByComparator<JournalArticle>.

Methods

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

Delegate

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

• - screenlet:onWebContentListResponse:: Called when a page of contents is received. Note that this method may be called more than once: one call for each page received.

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

• - screenlet:onWebContentSelected:: Called when an item in the list is selected.