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

Overview
anchor

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

Use Cases
anchor

CreateGroupUseCase
anchor

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

Interface CreateGroupUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

DeleteGroupUseCase
anchor

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

Interface DeleteGroupUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetGroupUseCase
anchor

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

Interface GetGroupUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ListGroupsUseCase
anchor

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

Interface ListGroupsUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

UpdateGroupUseCase
anchor

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

Interface UpdateGroupUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

Event Handlers
anchor

GroupAfterCreateEventHandler
anchor

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

Interface GroupAfterCreateEventHandler.Interface:

Event payload GroupAfterCreateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

GroupAfterDeleteEventHandler
anchor

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

Interface GroupAfterDeleteEventHandler.Interface:

Event payload GroupAfterDeleteEventPayload:

Types:

Usage:

extensions/MyHandler.ts

GroupAfterUpdateEventHandler
anchor

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

Interface GroupAfterUpdateEventHandler.Interface:

Event payload GroupAfterUpdateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

GroupBeforeCreateEventHandler
anchor

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

Interface GroupBeforeCreateEventHandler.Interface:

Event payload GroupBeforeCreateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

GroupBeforeDeleteEventHandler
anchor

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

Interface GroupBeforeDeleteEventHandler.Interface:

Event payload GroupBeforeDeleteEventPayload:

Types:

Usage:

extensions/MyHandler.ts

GroupBeforeUpdateEventHandler
anchor

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

Interface GroupBeforeUpdateEventHandler.Interface:

Event payload GroupBeforeUpdateEventPayload:

Types:

Usage:

extensions/MyHandler.ts

Services
anchor

ModelGroupFactory
anchor

Abstraction — imported from webiny/api/cms/group

Interface ModelGroupFactory.Interface:

Types:

Usage:

extensions/MyImpl.ts

Types & Classes
anchor

CmsGroup
anchor

Type — imported from webiny/api/cms/group

A representation of content model group in the database.

@category CmsGroup @category Database model

CmsModelGroup
anchor

Type — imported from webiny/api/cms/group

@category Database model @category CmsModel