flowable / flowable/flowable-engine

Wrong information in the docs about event handlers

Open
#2,719 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
9.5k
Forks
2.9k
Avg merge
7h 8m
Merged PRs (30d)
2

Description

**Describe the bug**
While reading and performing tests agains the event handlers APIs, I found some problems with the docs, like wrong interface name and wrong class' members.

In the page https://flowable.com/open-source/docs/bpmn/ch03-Configuration/#event-handlers
The sentence

> The only requirement for an event-listener is to implement org.flowable.engine.delegate.event.FlowableEventListener

the right interface should be org.flowable.common.engine.api.delegate.event.FlowableEventListener

And in the https://flowable.com/open-source/docs/bpmn/ch03-Configuration/#supported-event-types page, the table below sentence

> Listed below are all event types that can occur in the engine. Each type corresponds to an enum value in the org.flowable.engine.common.api.delegate.event.FlowableEventType.

The enum values for MEMBERSHIP_CREATED, MEMBERSHIP_DELETED and MEMBERSHIPS_DELETED are defined in org.flowable.idm.api.event.FlowableIdmEventType

**Expected behavior**
A clear and concise description of what you expected to happen.

**Code**
If applicable, add the code that you are using when having the issue.

**Additional context**
Add the version of Flowable that you are using, the database vendor and if you are using Flowable within Spring Boot, the Flowable Task application etc.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.