Documentation

Liferay API Modules

The following table maps commonly used Liferay DXP components to their API modules and key classes. You configure dependencies on the component API modules to use them.

API Modules Table

ComponentClassesModule Symbolic Name (Artifact ID)
Application ListPanelAppcom.liferay.application.list.api
PanelCategory
PanelEntry
Background TasksBackgroundTask[Local]ServiceUtilcom.liferay.portal.background.task.api
BlogsBlogsEntry[Local]ServiceUtilcom.liferay.blogs.api
BookmarksBookmarksEntry[Local]ServiceUtilcom.liferay.bookmarks.api
BookmarksFolder[Local]ServiceUtil
CalendarCalendar[Local]ServiceUtilcom.liferay.calendar.api
CalendarBooking[Local]ServiceUtil
CalendarImporter
CalendarNotificationTemplate[Local]ServiceUtil
CalendarResource[Local]ServiceUtil
CommentCommentcom.liferay.comment.api
DiscussionComment
ContactsEntrycom.liferay.contacts.api
Document LibraryDLFileEntry[Local]ServiceUtilcom.liferay.document.library.api
DLContent[Local]ServiceUtil
DLFileEntryType[Local]ServiceUtil
DLFileVersion[Local]ServiceUtil
DLFolder[Local]ServiceUtil
DLSyncEvent[Local]ServiceUtil
Dynamic Data ListsDDLRecord[Local]ServiceUtilcom.liferay.dynamic.data.lists.api
DDLRecordSet[Local]ServiceUtil
DDLRecordVersion[Local]ServiceUtil
Dynamic Data MappingDDMContent[Local]ServiceUtilcom.liferay.dynamic.data.mapping.api
DDMStructure[Local]ServiceUtil
DDMStorageLink[Local]ServiceUtil
DDMStructureLayout[Local]ServiceUtil
DDMStructureLink[Local]ServiceUtil
DDMStructureVersion[Local]ServiceUtil
DDMTemplate[Local]ServiceUtil
DDMTemplateLink[Local]ServiceUtil
DDMTemplateVersion[Local]ServiceUtil
Export / ImportExportImportConfigurationcom.liferay.exportimport.api
StagingServiceUtil[Local]ServiceUtil
FlagsFlagsEntryServiceUtilcom.liferay.flags.api
InvitationMemberRequest[Local]ServiceUtilcom.liferay.invitation.invite.members.api
Item SelectorItemSelectorcom.liferay.item.selector.api
Item Selector CriteriaFileEntryItemSelectorReturnTypecom.liferay.item.selector.criteria.api
UploadableFileReturnType
URLItemSelectorReturnType
UUIDItemSelectorReturnType
LockLockcom.liferay.portal.lock.api
MapMapProvidercom.liferay.map.api
MarketplaceAppcom.liferay.marketplace.api
Module
MentionsMentionsNotifiercom.liferay.mentions.api
MentionsUserFinder
MentionsUtil
Message BoardsMBMessage[Local]ServiceUtilcom.liferay.message.boards.api
MBCategory[Local]ServiceUtil
MBThread[Local]ServiceUtil
MBDiscussion[Local]ServiceUtil
MicroblogsMicroblogsEntry[Local]ServiceUtilcom.liferay.microblogs.api
Mobile Device RulesMDRAction[Local]ServiceUtilcom.liferay.mobile.device.rules.api
MDRRule[Local]ServiceUtil
MDRRuleGroup[Local]ServiceUtil
MDRRuleGroupInstance[Local]ServiceUtil
PollsPollsChoice[Local]ServiceUtilcom.liferay.polls.api
PollsQuestion[Local]ServiceUtil
PollsVote[Local]ServiceUtil
Portal Access PolicySAPEntry[Local]ServiceUtilcom.liferay.portal.security.service.access.policy.api
Portal SettingsPortalSettingscom.liferay.portal.settings.api
Portlet ConfigurationPortletConfigurationIconcom.liferay.portlet.configuration.icon.locator.api
PortletToolbarcom.liferay.portlet.configuration.toolbar.contributor.locator.api
Private MessagingUserThread[Local]ServiceUtilcom.liferay.social.privatemessaging.api
Product NavigationProductNavigationControlMenuCategorycom.liferay.product.navigation.control.menu.api
ProductNavigationControlMenuEntry
RatingsRatingsEntry[Local]ServiceUtilcom.liferay.ratings.api
Reports EngineRulesEnginereports.engine.api
RulesLanguage
Fact
Query
ScreensScreensAssetEntryServiceUtilcom.liferay.screens.api
ScreensDDLRecordServiceUtil
ScreensJournalArticleServiceUtil
Security AuditAuditEventcom.liferay.portal.security.audit.api
AuditEventManager
AuditConfiguration
Security Import / ExportUserExportercom.liferay.portal.security.exportimport.api
UserImporter
UserOperation
Shopping CartShoppingCart[Local]ServiceUtilcom.liferay.shopping.api
ShoppingCategory[Local]ServiceUtil
ShoppingCoupon[Local]ServiceUtil
ShoppingItem[Local]ServiceUtil
ShoppingItemPrice[Local]ServiceUtil
ShoppingOrder[Local]ServiceUtil
ShoppingOrderItem[Local]ServiceUtil
SiteGroupSearchProvidercom.liferay.site.api
Social NetworkingMeetupsEntry[Local]ServiceUtilcom.liferay.social.networking.api
MeetupsRegistration[Local]ServiceUtil
WallEntry[Local]ServiceUtil
StagingStaging[Local]ServiceUtilcom.liferay.staging.api
Web ContentJournalArticle[Local]ServiceUtilcom.liferay.journal.api
JournalFolder[Local]ServiceUtil
JournalArticleImage[Local]ServiceUtil
JournalFeed[Local]ServiceUtil
WikiWikiNode[Local]ServiceUtilcom.liferay.wiki.api
WikiPage[Local]ServiceUtil
XStream ConfiguratorXStreamConfiguratorcom.liferay.xstream.configurator.api

For reference documentation on these APIs and others, see the the app reference docs at https://docs.liferay.com/dxp/apps and the Liferay DXP core reference docs at https://docs.liferay.com/dxp/digital-enterprise/7.0-latest.

Configuring Dependencies

Development Reference

Liferay Upgrade Planner

Was this article helpful?
0 out of 0 found this helpful