Audio 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

Audio Display Screenlet displays an audio file from a Liferay instance’s Documents and Media Library.

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
ScreensassetentryService (Screens compatibility plugin) getAssetEntry With entryId
ScreensassetentryService (Screens compatibility plugin) getAssetEntry With classPK and className
ScreensassetentryService (Screens compatibility plugin) getAssetEntries With entryQuery
ScreensassetentryService (Screens compatibility plugin) getAssetEntries With companyId, groupId, and portletItemName

Module

  • None

Views

  • Default

The Default View uses an Android VideoView to display the audio file.

screens-android-audiodisplay.png

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

  • entryId

If you don’t use entryId, you must use both of the following attributes:

  • className
  • classPK

Attributes

Attribute Data type Explanation
layoutId @layout The layout to use to show the View.
autoLoad boolean Whether the audio file automatically loads when the Screenlet appears in the app’s UI. The default value is true.
entryId number The primary key of the audio file.
className string The audio file’s fully qualified class name. Since files in a Documents and Media Library are DLFileEntry objects, their className is com.liferay.portlet.documentlibrary.model.DLFileEntry. The className and classPK attributes are required to instantiate the Screenlet.
classPK number The audio file’s unique identifier. The className and classPK attributes are required to instantiate the Screenlet.
cachePolicy string The offline mode setting. See the Offline section for details.

Listener

Because audio files are assets, Audio Display Screenlet delegates its events to a class that implements AssetDisplayListener. This interface lets you implement the following methods:

  • onRetrieveAssetSuccess(AssetEntry assetEntry): Called when the Screenlet successfully loads the audio file.

  • 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)
Video Display Screenlet for Android Previous