init
This commit is contained in:
55
docs/ai/Common/DTS.CommonCore/Events/ChannelCodes.md
Normal file
55
docs/ai/Common/DTS.CommonCore/Events/ChannelCodes.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
source_files:
|
||||
- Common/DTS.CommonCore/Events/ChannelCodes/ChannelCodesViewChangedEvent.cs
|
||||
- Common/DTS.CommonCore/Events/ChannelCodes/ChannelCodeCommittedEvent.cs
|
||||
generated_at: "2026-04-17T16:37:05.716975+00:00"
|
||||
model: "zai-org/GLM-5-FP8"
|
||||
schema_version: 1
|
||||
sha256: "b761fbf8ad38db94"
|
||||
---
|
||||
|
||||
# Documentation: Channel Code Events
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This module defines two Prism event types for the event aggregation system, enabling loosely-coupled communication between components regarding channel code operations. `ChannelCodesViewChangedEvent` notifies subscribers when the channel codes view mode changes, while `ChannelCodeCommittedEvent` broadcasts when channel codes are committed, carrying details about the committed codes and user permissions. These events follow the Prism CompositePresentationEvent pattern for pub/sub messaging within the DTS application.
|
||||
|
||||
---
|
||||
|
||||
## 2. Public Interface
|
||||
|
||||
### `ChannelCodesViewChangedEvent`
|
||||
**Location:** `DTS.Common.Events` namespace
|
||||
**Declaration:**
|
||||
```csharp
|
||||
public class ChannelCodesViewChangedEvent : CompositePresentationEvent<DTS.Common.Enums.IsoViewMode> { }
|
||||
```
|
||||
**Behavior:** An event class that publishes/subscribes to view mode changes. The payload is a single `DTS.Common.Enums.IsoViewMode` value indicating the new view mode.
|
||||
|
||||
---
|
||||
|
||||
### `ChannelCodeCommittedEvent`
|
||||
**Location:** `DTS.Common.Events.ChannelCodes` namespace
|
||||
**Declaration:**
|
||||
```csharp
|
||||
public class ChannelCodeCommittedEvent : CompositePresentationEvent<ChannelCodeCommittedEventArgs[]> { }
|
||||
```
|
||||
**Behavior:** An event class that publishes/subscribes to channel code commit notifications. The payload is an array of `ChannelCodeCommittedEventArgs` objects, allowing multiple codes to be committed in a single event.
|
||||
|
||||
---
|
||||
|
||||
### `ChannelCodeCommittedEventArgs`
|
||||
**Location:** `DTS.Common.Events.ChannelCodes` namespace
|
||||
**Properties:**
|
||||
|
||||
| Property | Type | Access |
|
||||
|----------|------|--------|
|
||||
| `ChannelCodeType` | `ChannelEnumsAndConstants.ChannelCodeType` | `public` getter, `private` setter |
|
||||
| `Code` | `string` | `public` getter, `private` setter |
|
||||
| `Name` | `string` | `public` getter, `private` setter |
|
||||
| `CanUserCommitChannelCodes` | `bool` | `public` getter, `private` setter |
|
||||
|
||||
**Constructor:**
|
||||
```csharp
|
||||
public ChannelCodeCommittedEventArgs(
|
||||
ChannelEnumsAndConstants.ChannelCodeType channelCode
|
||||
Reference in New Issue
Block a user