docs: apply reviewed wiki editorial corrections
docs: add ASP.NET hosting guide and clarify SDK behavior
docs: apply wiki editorial audit findings
Apply 107 findings across 49 pages, including revised wording, sentence case headings, and event terminology. Leave the deferred MP4 metadata finding unchanged.
docs: document camera geographical location
docs: apply Genetec style guide to platform-sdk pages
docs: add unit password change actions to the cameras guide
Document ActionManager.ChangeUnitPassword (supplied and auto-generated) and ChangeUnitPasswordBatch, with the required privileges and Unit Assistant role. Verified against the 5.14 SDK.
docs: improve SDK documentation accuracy and clarity
docs: correct verified inaccuracies across Plugin and Platform SDK reference pages
Plugin SDK:
- Separate plugin configuration from the RequestManager: config pages read
and write SpecificConfiguration/RestrictedConfiguration directly through
Workspace.Sdk/Engine, not through request round trips
- Rework request handling to use payload-only responses with exception
propagation (SdkException) instead of Success/Error envelopes; remove
unverified thread-safety guidance
- Clarify ModifyEntityState usage and plugin-owned entity lifecycle across
role restarts
Platform SDK:
- MediaPlayer: document the local-file playback path; correct cache-folder
and synchronization details
- Cameras: correct SupportsLiveStreaming semantics and UpdateNetworkSettings
behavior
- Cardholders/credentials: correct credential assignment, CredentialType, and
format-change behavior
- Doors: correct access-point connection types and AccessPermissionLevel
- Entities/entity cache: fix base-class prose and disposed-entity access
- Transactions: correct transaction overhead and update-lock guidance
docs: fix verified inaccuracies across SDK wiki pages
Corrects claims that did not match SDK 5.14 source or reflection,
including ownership/removal semantics, disposal and lifecycle
behavior, plugin hosting and assembly resolution, entity cache
filtering, and several style and cross-reference fixes.
docs: apply SDK audit corrections across Platform, Media, Plugin, and Workspace pages
Address factual and API-accuracy issues identified by the SDK documentation
audit: corrected obsolete and internal identifiers, removed an internal
certificate error name from reader-facing text, fixed inverted and missing
default-state notes, narrowed over-broad capability claims, and reworded to
observable behavior. Also adds a strongly typed interface-builder example for
access control units and clarifies AddMapping upsert semantics.
docs: correct Platform, Media, Plugin, and Workspace SDK guidance
docs: normalize See also descriptions and remove cross-SDK leakage
- Capitalize first letter of See also descriptions per wiki-style-reviewer
LIST-01/LIST-06/LINK-09 across 29 pages
- Apply canonical descriptions for shared cross-references (0
inconsistencies across 109 cross-references)
- Remove Platform -> Web/Workspace/Plugin See also links (audience
mismatch: Platform SDK reader does not reach for Web/Workspace/Plugin
SDK from a C# integration context)
- Remove 2 inline Platform -> Web body cross-references
- Add IsNetworkSettingsCombinationValid result examples and PTZ
zoom-factor explanation in web-sdk-video.md
Revert "docs(platform-sdk): canonical alphabetical ordering for See also sections"
This reverts commit 2229e4b6f10517da2090372404ab089c89586de8.
docs(platform-sdk): canonical alphabetical ordering for See also sections
Reorders See also entries alphabetically by link text on the pages
edited this session. Removes editorial bias in which subsystem appears
first; the order is now produced by the link title rather than by an
implicit framing choice. Also lowercases description text where the
prior pattern accidentally had Title Case openings.
docs(platform-sdk): value-density pass on the 14 video and access-control pages
Following an external content-value review, restructured the pages to
cut sections that read as compressed API reference (work IntelliSense
and XML doc comments already do) and lead with the operational and
workflow content that the wiki is uniquely positioned to provide.
Hubs become decision maps. platform-sdk-video.md and
platform-sdk-access-control.md no longer have an H2 per spoke that
introduces a concept and points at the spoke; they now have a short
"Where to go next" route table and keep only the orientation prose
(layered model, "archives go through the report manager", archive
transfer taxonomy, RecordingProblem as health signal, what-if checks
without the hardware).
Spokes become task-oriented. platform-sdk-cameras.md has a "Common
tasks" route block at the top, organizes around configure recording,
trigger manual recording, select streams, manage bookmarks, protect
video, and observe health, and drops property catalog bullets that
restated signatures (recording config, the long VideoStream setter
list, RecordingFrameInterval and StreamingType enum lists, the
adjacent video topics link farm).
platform-sdk-archiver-role.md now answers operational questions
("Which cameras is this archiver responsible for?", "Which server is
running it now?", "How do I detect recording failure before querying
archives?"). The certificate overload list and recording config
member list have been cut.
platform-sdk-cardholders-and-credentials.md, platform-sdk-doors-
and-access-points.md, platform-sdk-access-rules-and-schedules.md,
and platform-sdk-access-control-units.md have similar trim treatment:
"Common use cases" blocks removed, repeated property catalogs replaced
with prose that emphasizes non-obvious behavior, the access control
peripherals enum table replaced with a categorical paragraph.
Enrollment procedures get their own pages. platform-sdk-enrolling-a-
video-unit.md and platform-sdk-enrolling-an-access-control-unit.md
hold the workflows that previously lived at the bottom of the
respective entity pages. A developer searching for the task lands on
the procedure directly. The HID VertX secure-mode variant moves to the
access control enrollment page where it is relevant.
Source-of-truth fix caught while trimming: the RecordingProblem value
on archiver statistics lives on each ArchiverEncoderStatistics entry,
not on the disk-group level; the archiver-role example iterates
EncoderStats accordingly.
Sidebar: added "Enrolling a video unit" and "Enrolling an access
control unit" entries beside their hub-side spokes.
After all edits, every csharp block in the 14 hub/spoke pages plus the
two new procedure pages compiles cleanly against the live SDK
assemblies.
docs(platform-sdk): style audit + source-verified bug fixes across 11 pages
Style audit fixes (per /wiki-style-reviewer):
- Replaced em dashes throughout the video and access-control hubs and
spokes (cameras, cardholders-and-credentials, doors-and-access-points,
access-rules-and-schedules, access-control-units) with commas, colons,
or parentheses (PUNCT-03).
- Renamed "Archiver and Auxiliary Archiver roles" header to sentence case
on the video hub (HDR-05/WORD-05).
- Promoted bold labels (Doors, Areas, Elevators, Access points) to H3
headers on the access-control hub (HDR-02).
- Added a See also section to archive-transfer.md and custom-fields.md
(LINK-09).
- Reformatted maps.md See also entries from sentence style to colon-
delimited (LINK-09).
- Corrected doors-and-access-points See also link text to match the
target page H1.
- Folded the LoadCertificate "// your loader" comment into prose on
archiver-role.md (CODE-05).
Source-of-truth corrections (caught by /dap-wiki-verify-code):
- Replaced fictional `IsOnlineChangedEventArgs.IsOnline` access on
video.md and cameras.md; the args type has no such property. Reading
unit.IsOnline directly inside the handler is the correct pattern.
- Corrected `CardholderAccessPointInfo.AccessPoint` to `AccessPointGuid`
(the actual property) on access-control.md and
cardholders-and-credentials.md.
- Corrected `AccessRuleRecord.AccessRule` to `Id` (the actual property)
on access-control.md and doors-and-access-points.md.
- Corrected the `CredentialType` enum description on access-control.md
to the real values (None, Keypad, UndecodedWiegand, LicensePlate,
CardRequest).
- Replaced the placeholder `/* value */` argument in the SetProperty
example with a typed value so the example compiles.
- Replaced the unspecified `ToSecureString` helper in cameras.md and
access-control-units.md with `new NetworkCredential("", "...")
.SecurePassword`, which is self-contained.
- Restructured the maps.md "Removing a map object" example to declare
the map object inside its own block instead of relying on a prior
block's local.
- Merged steps 2 and 3 of the access-control-units enrollment
procedure so the AddAccessControlUnitInfo and EnrollAccessControlUnit
call live in the same block.
- Fixed the cardholders-and-credentials procedural verification print
to use Status.State instead of formatting the status object directly.
- Dropped the "future platform-sdk-credential-formats topic" forward
reference on the cardholders spoke.
After fixes, all 113 csharp blocks across the 14 pages compile cleanly
against the live SDK assemblies.
docs(platform-sdk): add procedural sections for video and access-control workflows
Adds task-oriented procedures to four spokes:
- platform-sdk-cameras: enrolling a video unit through IVideoUnitManager.
- platform-sdk-access-control-units: enrolling a unit through IAccessControlUnitManager.
- platform-sdk-cardholders-and-credentials: creating a cardholder with credentials end-to-end.
- platform-sdk-access-rules-and-schedules: creating an access rule and attaching it to a door side.
Each procedure has prerequisites and numbered steps backed by source. Also corrects the credential builder acquisition wording on the cardholders spoke to point at Engine.EntityManager.GetCredentialBuilder().
docs(platform-sdk): add video and access-control spokes; wire up hubs
Adds six conceptual spokes referenced by the video and access-control hubs:
platform-sdk-cameras, platform-sdk-archiver-role,
platform-sdk-cardholders-and-credentials, platform-sdk-doors-and-access-points,
platform-sdk-access-rules-and-schedules, and platform-sdk-access-control-units.
Replaces the "future spoke is planned" promises in both hubs with cross-links
to the new pages, drops the threat-levels future-spoke promise, corrects the
CredentialType enum description on the access-control hub, and expands both
See also lists.