[rules] Improve docs of file-based event object

Signed-off-by: Florian Hotze <[email protected]>

README.md

@@ -1322,10 +1322,15 @@ This table gives an overview over the `event` object:
 | `time`            | `TimeOfDayTrigger`                                  | Time of day value of the trigger                                              | N/A                    |
 | `eventType`       | all except `PWMTrigger`, `PIDTrigger`               | Type of event that triggered event (change, command, triggered, update, time) | N/A                    |
 | `triggerType`     | all except `PWMTrigger`, `PIDTrigger`               | Type of trigger that triggered event                                          | N/A                    |
+| `eventClass`      | all                                                 | Java class name of the triggering event                                       | N/A                    |
 | `module`          | all                                                 | (user-defined or auto-generated) name of trigger                              | N/A                    |
 
 All properties are typeof `string`.
 
+Please note that when using `GenericEventTrigger`, the available properties depend on the chosen event types.
+It is not possible for the openhab-js library to provide type conversions for all properties of all openHAB events, as those are too many.
+In case the event object does not provide type-conversed properties for your chosen event type, use the `payload` property to gain access to the event's (Java data type) payload.
+
 **NOTE:**
 `Group****Trigger`s use the equivalent `Item****Trigger` as trigger for each member.
 Time triggers do not provide any event instance, therefore no property is populated.

rules/rules.js

@@ -29,8 +29,9 @@
  * @property {string} time for {@link triggers.TimeOfDayTrigger}: time of day value of the trigger
  * @property {string} eventType for all triggers except {@link triggers.PWMTrigger}, {@link triggers.PIDTrigger}: Type of event that triggered event (change, command, time, triggered, update, time)
  * @property {string} triggerType for all triggers except {@link triggers.PWMTrigger}, {@link triggers.PIDTrigger}: Type of trigger that triggered event
+ * @property {string} eventClass for all triggers: Java class name of the triggering event
  * @property {string} module (user-defined or auto-generated) name of trigger
- * @property {*} payload for most triggers
+ * @property {*} payload if provided by event: payload of event in Java data types
  */
 
 /**

types/rules/rules.d.ts

@@ -70,12 +70,16 @@ export type EventObject = {
      * for all triggers except {@link triggers.PWMTrigger }, {@link triggers.PIDTrigger }: Type of trigger that triggered event
      */
     triggerType: string;
+    /**
+     * for all triggers: Java class name of the triggering event
+     */
+    eventClass: string;
     /**
      * (user-defined or auto-generated) name of trigger
      */
     module: string;
     /**
-     * for most triggers
+     * if provided by event: payload of event in Java data types
      */
     payload: any;
 };