Asset 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
  • Liferay Screens Compatibility app (CE or EE/DXP). This app is preinstalled in Liferay CE Portal 7.0/7.1 and Liferay DXP.

Compatibility

  • iOS 9 and above

Xamarin Requirements

  • Visual Studio 7.2
  • Mono .NET framework 5.4.1.6

Features

The Asset List Screenlet can be used to show lists of assets from a Liferay instance. For example, you can use the Screenlet to show a scrollable collection of assets. It also implements fluent pagination with configurable page size. The Asset List Screenlet can show assets of the following classes:

  • BlogsEntry
  • BookmarksEntry
  • BookmarksFolder
  • CalendarEvent
  • DLFileEntry
  • DDLRecord
  • DDLRecordSet
  • Group
  • JournalArticle (Web Content)
  • JournalFolder
  • Layout
  • LayoutRevision
  • MBThread
  • MBCategory
  • MBDiscussion
  • MBMailingList
  • Organization
  • User
  • WikiPage
  • WikiPageResource
  • WikiNode

The Asset List Screenlet also 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.

ServiceMethodNotes
ScreensddlrecordService (Screens compatibility plugin)getAssetEntriesWith entryQuery
ScreensddlrecordService (Screens compatibility plugin)getAssetEntriesWith companyId, groupId, and portletItemName
AssetEntryServicegetEntriesCount

Module

  • None

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 items.

Figure 1: Asset List Screenlet using the Default (default) Theme.

Figure 1: Asset 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:

PolicyWhat happensWhen to use
remote-onlyThe Screenlet loads the list from the portal. 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-onlyThe 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-firstThe Screenlet loads the list from the portal. 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 an outdated version when there’s no connection.
cache-firstThe Screenlet loads the list from the local cache. If the list isn’t there, the Screenlet requests it from the portal 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

  • classNameId

If you don’t use classNameId, you must use this attribute:

  • portletItemName

Attributes

AttributeData typeExplanation
groupIdnumberThe ID of the site (group) where the asset is stored. If set to 0, the groupId specified in LiferayServerContext is used. The default value is 0.
classNameIdnumberThe ID of the asset’s class name. Use values from the AssetClassNameId class or the Liferay Instance’s classname_ database table.
portletItemNamestringThe name of the configuration template you used in the Asset Publisher. To use this feature, add an Asset Publisher to one of your site’s pages (it may be a hidden page), configure the Asset Publisher’s filter (in ConfigurationSetupAsset Selection), and then use the Asset Publisher’s Configuration Templates option to save this configuration with a name. Use this name as this attribute’s value.
offlinePolicystringThe offline mode setting. The default value is remote-first. See the Offline section for details.
autoLoadbooleanWhether the list loads automatically when the Screenlet appears in the app’s UI. The default value is true.
refreshControlbooleanDefines whether a standard ios UIRefreshControl appears when the user does the pull to refresh gesture. The default value is true.
firstPageSizenumberThe number of items retrieved from the server for display on the first page. The default value is 50.
pageSizenumberThe number of items retrieved from the server for display on the second and subsequent pages. The default value is 25.
customEntryQueryDictionaryThe set of keys (string) and values (string or number) to be used in the AssetEntryQuery object. These values filter the assets returned by the Liferay instance.

Methods

MethodReturnExplanation
loadList()booleanStarts the request to load the list of assets. This list is shown when the response is received. Returns true if the request is sent.

Delegate

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

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

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

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

« DDL List Screenlet for iOSWeb Content Display Screenlet for iOS »
Was this article helpful?
0 out of 0 found this helpful