Adding .NET docs for Events to API reference

[kemerava]

Describe your change

Adding .NET docs for Events to API reference
@bingenito hope I did not steal your issue! :) I really wanted to try to give it a go, could you please review it, as I was not sure if there are better ways of implementing it in some places.

Related Issue

resolves #1318

Contributor License Agreement

• I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.

Review Checklist

• Issue: If a change was made to the FDC3 Standard, was an issue linked above?
• CHANGELOG: Is a CHANGELOG.md entry included?
• API changes: Does this PR include changes to any of the FDC3 APIs (DesktopAgent, Channel, PrivateChannel, Listener, Bridging)?
  • Docs & Sources: If yes, were both documentation (/docs) and sources updated?
    
    JSDoc comments on interfaces and types should be matched to the main documentation in /docs
  • Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?
    
    Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined
  • Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?
    
    The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other
    • If yes, was code generation (npm run build) run and the results checked in?
      
      Generated code will be found at /src/api/BrowserTypes.ts and/or /src/bridging/BridgingTypes.ts
• Context types: Were new Context type schemas created or modified in this PR?
  • Were the field type conventions adhered to?
  • Was the BaseContext schema applied via allOf (as it is in existing types)?
  • Was a title and description provided for all properties defined in the schema?
  • Was at least one example provided?
  • Was code generation (npm run build) run and the results checked in?
    
    Generated code will be found at /src/context/ContextTypes.ts
• Intents: Were new Intents created in this PR?
  • Were the intent name prefixes and other naming conventions & characteristics adhered to?
  • Was the new intent added to the list in the Intents Overview?

[netlify]

✅ Deploy Preview for fdc3 ready!

Name	Link
🔨 Latest commit	3b4d107
🔍 Latest deploy log	https://app.netlify.com/sites/fdc3/deploys/67508080e0b41b0008032b8d
😎 Deploy Preview	https://deploy-preview-1441--fdc3.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[kemerava]

Sorry @bingenito, had to resolve the merge conflicts, could please re-review?

[kriswest]

The tab selection headers are not appearing on Events.md, e.g.:

https://deploy-preview-1441--fdc3.netlify.app/docs/next/api/ref/Events
vs.

https://deploy-preview-1441--fdc3.netlify.app/docs/next/api/ref/DesktopAgent

That's probably because that page needs the following to be added at the top, right after the metadata block:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

See DesktopAgent.md for an example.

Regarding the definitions contained in the PR, all looks good to me, but I wonder if the Details class might need a better-scoped name such as EventDetails or Fdc3EventDetails. There are already two different sub-classes (both called Details currently) for the channel changed event and Private Channel addContextListener/unsubscribe events, should they be better namespaced? Happy to defer to you and @bingenito on that, but thought to ask.

[kemerava]

Thanks for the review @kriswest! Fixed the imports. I like the EventDetails idea, however, would love to hear also what @bingenito thinks! Thanks both

[bingenito]

I favor Fdc3EventDetails but this is also a placeholder. I've started the implementation of this (copying these as the definition) and will work out where it makes sense to change once we write tests against it and get a feel for naming. We can then circle back and update the docs to match?

[kemerava]

Thanks, @bingenito. Works for me, do you want to keep this open until then, or should we merge as is and it will be updated later?

[bingenito]

@kemerava let's hold off a bit. As I'm implementing this I'm thinking of mirroring context types and having IApiEvent<T> where T is the type for the Details property. I'll create a draft PR over in fdc3-dotnet in the next few days and we can discuss there.