44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Events/ChannelCodes/ChannelCodesViewChangedEvent.cs
|
||
|
|
- Common/DTS.Common/Events/ChannelCodes/ChannelCodeCommittedEvent.cs
|
||
|
|
generated_at: "2026-04-17T16:07:34.968095+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "9d1faa44d38bcfed"
|
||
|
|
---
|
||
|
|
|
||
|
|
# ChannelCodes
|
||
|
|
|
||
|
|
### Purpose
|
||
|
|
This module defines event types for the Channel Codes subsystem within the DTS application. It provides pub/sub event definitions used to broadcast changes to channel code views and to notify the system when channel codes have been committed, carrying metadata about the committed code and user permissions.
|
||
|
|
|
||
|
|
### Public Interface
|
||
|
|
|
||
|
|
**`ChannelCodesViewChangedEvent`** (class, inherits `PubSubEvent<DTS.Common.Enums.IsoViewMode>`)
|
||
|
|
- Event payload: `DTS.Common.Enums.IsoViewMode` (enum value)
|
||
|
|
- Purpose: Broadcasts when the channel codes view mode has changed.
|
||
|
|
|
||
|
|
**`ChannelCodeCommittedEvent`** (class, inherits `PubSubEvent<ChannelCodeCommittedEventArgs[]>`)
|
||
|
|
- Event payload: Array of `ChannelCodeCommittedEventArgs`
|
||
|
|
- Purpose: Broadcasts when one or more channel codes have been committed.
|
||
|
|
|
||
|
|
**`ChannelCodeCommittedEventArgs`** (class)
|
||
|
|
- Constructor: `ChannelCodeCommittedEventArgs(ChannelEnumsAndConstants.ChannelCodeType channelCodeType, string code, string name, bool canUserCommitChannelCodes)`
|
||
|
|
- Properties:
|
||
|
|
- `ChannelCodeType` (`ChannelEnumsAndConstants.ChannelCodeType`) - The type of channel code.
|
||
|
|
- `Code` (`string`) - The code identifier.
|
||
|
|
- `Name` (`string`) - The display name.
|
||
|
|
- `CanUserCommitChannelCodes` (`bool`) - Indicates whether the user submitting the event has write privilege for channel codes.
|
||
|
|
|
||
|
|
### Invariants
|
||
|
|
- `ChannelCodeCommittedEventArgs` properties are set only via constructor and are read-only (private setters).
|
||
|
|
- `ChannelCodeCommittedEvent` publishes an array of event args, not a single instance.
|
||
|
|
|
||
|
|
### Dependencies
|
||
|
|
- **Depends on**: `Prism.Events` (for `PubSubEvent<T>` base class), `DTS.Common.Enums` (for `IsoViewMode`), `DTS.Common.Enums.Channels` (for `ChannelEnumsAndConstants.ChannelCodeType`).
|
||
|
|
|
||
|
|
### Gotchas
|
||
|
|
- The file `ChannelCodesViewChangedEvent.cs` suppresses the ReSharper namespace check, suggesting the file location may not match the declared namespace (`DTS.Common.Events` vs. expected `DTS.Common.Events.ChannelCodes`). This could cause confusion when locating the class.
|
||
|
|
|
||
|
|
---
|