51 lines
2.3 KiB
Markdown
51 lines
2.3 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Events/Groups/GroupsList/GroupListEditGroupEvent.cs
|
||
|
|
- Common/DTS.Common/Events/Groups/GroupsList/GroupListGroupSelectedEvent.cs
|
||
|
|
generated_at: "2026-04-17T16:37:48.828756+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "42ef77f2b2284294"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: DTS.Common.Events.Groups.GroupList
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines event types for the Group List feature using Prism's event aggregation pattern. These events enable decoupled publish/subscribe communication between components in the application when group-related user actions occur, such as selecting groups or initiating an edit operation. The events carry integer-based identifiers as payloads.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `GroupListEditGroupEvent`
|
||
|
|
- **Signature:** `public class GroupListEditGroupEvent : PubSubEvent<int>`
|
||
|
|
- **Behavior:** An event that publishes an `int` payload, intended to signal that a group edit operation should be initiated. The payload represents a single group identifier.
|
||
|
|
|
||
|
|
### `GroupListGroupSelectedEvent`
|
||
|
|
- **Signature:** `public class GroupListGroupSelectedEvent : PubSubEvent<int[]>`
|
||
|
|
- **Behavior:** An event that publishes an `int[]` payload, intended to signal that one or more groups have been selected. The payload is an array of group identifiers.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 3. Invariants
|
||
|
|
|
||
|
|
- `GroupListEditGroupEvent` always carries a single `int` payload representing a group ID.
|
||
|
|
- `GroupListGroupSelectedEvent` always carries an `int[]` payload representing zero or more group IDs.
|
||
|
|
- Both event types inherit from `PubSubEvent<T>`, guaranteeing they follow Prism's event aggregation contract.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
|
||
|
|
**This module depends on:**
|
||
|
|
- `Prism.Events` — Provides the `PubSubEvent<T>` base class for event aggregation.
|
||
|
|
|
||
|
|
**What depends on this module:**
|
||
|
|
- Unknown from source alone. Consumers would be any component that publishes or subscribes to these events via Prism's `IEventAggregator`.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 5. Gotchas
|
||
|
|
|
||
|
|
- **Stale XML documentation:** Both classes contain XML comments referencing `GroupTemplateListGroupTemplateSelectedEvent` and "called when a template is selected." This appears to be copy-paste documentation that does not match the actual class names or their intended purposes (group editing and group selection, not template selection). The documentation should not be trusted as accurate.
|