WHAT YOU'LL LEARN
  • What use cases are available in webiny/api/cms/entry?
  • Which event handlers can you implement?
  • How to import and use each exported item?

Overview
anchor

This page documents everything exported from webiny/api/cms/entry. Import any of the items below directly from this path in your Webiny extensions.

Use Cases
anchor

CreateEntryRevisionFromUseCaseCreateEntryUseCaseDeleteEntryRevisionUseCaseDeleteEntryUseCaseDeleteMultipleEntriesUseCaseGetEntriesByIdsUseCaseGetEntryByIdUseCaseGetEntryUseCaseGetLatestDeletedRevisionByEntryIdUseCaseGetLatestEntriesByIdsUseCaseGetLatestRevisionByEntryIdBaseUseCaseGetLatestRevisionByEntryIdIncludingDeletedUseCaseGetLatestRevisionByEntryIdUseCaseGetPreviousRevisionByEntryIdBaseUseCaseGetPreviousRevisionByEntryIdUseCaseGetPublishedEntriesByIdsUseCaseGetPublishedRevisionByEntryIdUseCaseGetRevisionByIdUseCaseGetRevisionsByEntryIdUseCaseGetSingletonEntryUseCaseListDeletedEntriesUseCaseListEntriesUseCaseListLatestEntriesUseCaseListPublishedEntriesUseCaseMoveEntryToBinUseCaseMoveEntryUseCasePublishEntryUseCaseRepublishEntryUseCaseRestoreEntryFromBinUseCaseUnpublishEntryUseCaseUpdateEntryUseCaseUpdateSingletonEntryUseCaseValidateEntryUseCase

CreateEntryRevisionFromUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface CreateEntryRevisionFromUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

CreateEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface CreateEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

DeleteEntryRevisionUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface DeleteEntryRevisionUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

DeleteEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface DeleteEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

DeleteMultipleEntriesUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface DeleteMultipleEntriesUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetEntriesByIdsUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetEntriesByIdsUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetEntryByIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetEntryByIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetLatestDeletedRevisionByEntryIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetLatestDeletedRevisionByEntryIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetLatestEntriesByIdsUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetLatestEntriesByIdsUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetLatestRevisionByEntryIdBaseUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetLatestRevisionByEntryIdBaseUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetLatestRevisionByEntryIdIncludingDeletedUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetLatestRevisionByEntryIdIncludingDeletedUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetLatestRevisionByEntryIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetLatestRevisionByEntryIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetPreviousRevisionByEntryIdBaseUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetPreviousRevisionByEntryIdBaseUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetPreviousRevisionByEntryIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetPreviousRevisionByEntryIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetPublishedEntriesByIdsUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetPublishedEntriesByIdsUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetPublishedRevisionByEntryIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetPublishedRevisionByEntryIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetRevisionByIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetRevisionByIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetRevisionsByEntryIdUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetRevisionsByEntryIdUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetSingletonEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface GetSingletonEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ListDeletedEntriesUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface ListDeletedEntriesUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ListEntriesUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface ListEntriesUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ListLatestEntriesUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface ListLatestEntriesUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ListPublishedEntriesUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface ListPublishedEntriesUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

MoveEntryToBinUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface MoveEntryToBinUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

MoveEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface MoveEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

PublishEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface PublishEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

RepublishEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface RepublishEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

RestoreEntryFromBinUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface RestoreEntryFromBinUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

UnpublishEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface UnpublishEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

UpdateEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface UpdateEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

UpdateSingletonEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface UpdateSingletonEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ValidateEntryUseCase
anchor

Use Case Abstraction — imported from webiny/api/cms/entry

Interface ValidateEntryUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

Event Handlers
anchor

EntryAfterCreateEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterCreateEventHandler.Interface:

Event payload EntryAfterCreateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterDeleteEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterDeleteEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterDeleteMultipleEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterDeleteMultipleEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterMoveEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterMoveEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterPublishEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterPublishEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterRepublishEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterRepublishEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterRestoreFromBinEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterRestoreFromBinEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterUnpublishEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterUnpublishEventHandler.Interface:

Event payload EntryAfterUnpublishEventPayload:

Types:

Usage:

extensions/MyHandler.ts

EntryAfterUpdateEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryAfterUpdateEventHandler.Interface:

Event payload EntryAfterUpdateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeCreateEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeCreateEventHandler.Interface:

Event payload EntryBeforeCreateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeDeleteEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeDeleteEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeDeleteMultipleEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeDeleteMultipleEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeMoveEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeMoveEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforePublishEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforePublishEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeRepublishEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeRepublishEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeRestoreFromBinEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeRestoreFromBinEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeUnpublishEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeUnpublishEventHandler.Interface:

Event payload EntryBeforeUnpublishEventPayload:

Types:

Usage:

extensions/MyHandler.ts

EntryBeforeUpdateEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryBeforeUpdateEventHandler.Interface:

Event payload EntryBeforeUpdateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

EntryRevisionAfterCreateEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryRevisionAfterCreateEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryRevisionAfterDeleteEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryRevisionAfterDeleteEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryRevisionBeforeCreateEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryRevisionBeforeCreateEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

EntryRevisionBeforeDeleteEventHandler
anchor

Event Handler Abstraction — imported from webiny/api/cms/entry

Interface EntryRevisionBeforeDeleteEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

Services
anchor

CmsSortMapper
anchor

Abstraction — imported from webiny/api/cms/entry

Interface CmsSortMapper.Interface:

Types:

Usage:

extensions/MyImpl.ts

CmsWhereMapper
anchor

Abstraction — imported from webiny/api/cms/entry

Interface CmsWhereMapper.Interface:

Types:

Usage:

extensions/MyImpl.ts

Types & Classes
anchor

CmsEntry
anchor

Type — imported from webiny/api/cms/entry

A content entry definition for and from the database.

@category Database model @category CmsEntry

CmsEntryValues
anchor

Type — imported from webiny/api/cms/entry

A content entry values definition for and from the database.

@category Database model @category CmsEntry

EntryId
anchor

Class — imported from webiny/api/cms/entry