Add tab mentioning not implemented for obsolete/experiemental members

finos · Aug 21, 2024 · a5a9e94 · a5a9e94
1 parent 9e4d864
commit a5a9e94
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/docs/api/ref/Channel.md b/docs/api/ref/Channel.md
@@ -446,6 +446,12 @@ public addContextListener(handler: ContextHandler): Promise<Listener>;
 ```
 
 </TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
+</TabItem>
+
 </Tabs>
 
 Adds a listener for incoming contexts whenever a broadcast happens on the channel.

diff --git a/docs/api/ref/DesktopAgent.md b/docs/api/ref/DesktopAgent.md
@@ -186,6 +186,11 @@ var contactListener = await _desktopAgent.AddContextListener<Contact>("fdc3.cont
 addEventListener(type: FDC3EventType  | null, handler: EventHandler): Promise<Listener>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -209,6 +214,11 @@ const userChannelChangedListener = await fdc3.addEventListener(FDC3EventType.USE
 });
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -1447,6 +1457,11 @@ await _desktopAgent.RaiseIntentForContext(context, targetAppIdentifier);
 addContextListener(handler: ContextHandler): Promise<Listener>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -1465,6 +1480,11 @@ Adds a listener for incoming context broadcasts from the Desktop Agent. Provided
 getSystemChannels() : Promise<Array<Channel>>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -1482,6 +1502,11 @@ Alias to the [`getUserChannels`](#getuserchannels) function provided for backwar
 joinChannel(channelId: string) : Promise<void>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -1500,6 +1525,11 @@ Alias to the [`joinUserChannel`](#joinuserchannel) function provided for backwar
 open(name: string, context?: Context): Promise<AppIdentifier>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -1518,6 +1548,11 @@ Version of `open` that launches an app by name rather than `AppIdentifier`. Prov
 raiseIntent(intent: string, context: Context, name: string): Promise<IntentResolution>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 
@@ -1536,6 +1571,11 @@ Version of `raiseIntent` that targets an app by name rather than `AppIdentifier`
 raiseIntentForContext(context: Context, name: string): Promise<IntentResolution>;
 ```
 
+</TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
 </TabItem>
 </Tabs>
 

diff --git a/docs/api/ref/Errors.md b/docs/api/ref/Errors.md
@@ -373,6 +373,12 @@ enum BridgingError {
 ```
 
 </TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
+</TabItem>
+
 </Tabs>
 
 Contains constants representing the errors that can be encountered when queries are forwarded to a Desktop Agent Bridge, but one or more remote Desktop Agents connected to it disconnects, times-out or a malformed message is encountered while a particular request is in flight. These errors may be returned via the FDC3 API when a Desktop Agent is (or was) connected to a Desktop Agent Bridge.

diff --git a/docs/api/ref/Types.md b/docs/api/ref/Types.md
@@ -171,6 +171,12 @@ interface DesktopAgentIdentifier {
 ```
 
 </TabItem>
+<TabItem value="dotnet" label=".NET">
+
+Not implemented
+
+</TabItem>
+
 </Tabs>
 
 (Experimental) Identifies a particular Desktop Agent in Desktop Agent Bridging scenarios where a request needs to be directed to a Desktop Agent rather than a specific app, or a response message is returned by the Desktop Agent (or more specifically its resolver) rather than a specific app. Used as a substitute for `AppIdentifier` in cases where no app details are available or are appropriate.