Merge pull request #404 from ChartIQ/consolidate-listener-with-types

kriswest · web-flow · commit 47cd292fae42 · 2021-07-21T12:36:03.000+01:00
Consolidate Listener with other types in documentation
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -20,7 +20,7 @@ The focus of the FDC3 Standard Working Group has been to create a small but cons
 - [`window.fdc3`](ref/Globals#windowfdc3-object) global object and [`fdc3Ready`](ref/Globals#fdc3ready-event) event, for accessing FDC3 operations globally
 - [`DesktopAgent`](ref/DesktopAgent) interface, which exposes FDC3 operations
 - [`Channel`](ref/Channel) interface, for subscribing to specific context channels
-- [`Listener`](ref/Listener) interface, which allows unsubscribing intent or context listeners
+- [`Listener`](ref/Types#listener) interface, which allows unsubscribing intent or context listeners
 
 ## Usage
 
diff --git a/docs/api/ref/Channel.md b/docs/api/ref/Channel.md
@@ -33,6 +33,7 @@ interface Channel {
 #### See also
 
 * [`Context`](Types#context)
+* [`Listener`](Types#listener)
 * [`DesktopAgent.getSystemChannels`](DesktopAgent#getsystemchannels)
 * [`DesktopAgent.getOrCreateChannel`](DesktopAgent#getorcreatechannel)
 * [`DesktopAgent.joinChannel`](DesktopAgent#joinchannel)
@@ -118,7 +119,7 @@ instrumentListener.unsubscribe();
 ```
 
 #### See also
-* [`Listener`](Listener)
+* [`Listener`](Types#listener)
 * [`ContextHandler`](Types#contexthandler)
 * [`broadcast`](#broadcast)
 * [`getCurrentContext`](#getcurrentcontext)
diff --git a/docs/api/ref/DesktopAgent.md b/docs/api/ref/DesktopAgent.md
@@ -68,7 +68,7 @@ const contactListener = fdc3.addContextListener('fdc3.contact', contact => { ...
 ```
 
 #### See also
-* [`Listener`](Listener)
+* [`Listener`](Types#listener)
 * [`Context`](Types#context)
 
 
@@ -89,7 +89,7 @@ const listener = fdc3.addIntentListener('StartChat', context => {
 ```
 
 #### See also
-* [`Listener`](Listener)
+* [`Listener`](Types#listener)
 * [`Context`](Types#context)
 
 
diff --git a/docs/api/ref/Listener.md b/docs/api/ref/Listener.md
diff --git a/docs/api/ref/Types.md b/docs/api/ref/Types.md
@@ -49,6 +49,30 @@ Used when attaching listeners for context broadcasts and raised intents.
 * [`DesktopAgent.addContextListener`](DesktopAgent#addcontextlistener)
 * [`Channel.addContextListener`](Channel#addcontextlistener)
 
+## `Listener`
+
+A Listener object is returned when an application subscribes to intents or context broadcasts via the [`addIntentListener`](#addintentlistener) or [`addContextListener`](#addcontextlistener) methods on the [DesktopAgent](DesktopAgent) object.
+
+```typescript
+interface Listener {
+  unsubscribe(): void;
+}
+```
+#### `unsubscribe`
+
+```ts
+unsubscribe(): void;
+```
+
+Allows an application to unsubscribe from listening to intents or context broadcasts.
+
+#### See also
+* [`DesktopAgent.addIntentListener`](DesktopAgent#addintentlistener)
+* [`DesktopAgent.addContextListener`](DesktopAgent#addcontextlistener)
+* [`Channel.addContextListener`](Channel#addcontextlistener)
+* [`ContextHandler`](Types#contexthandler)
+
+
 ## `TargetApp`
 
 ```typescript
diff --git a/website/versioned_docs/version-1.2/api/overview.md b/website/versioned_docs/version-1.2/api/overview.md
@@ -21,7 +21,7 @@ The focus of the FDC3 Standard Working Group has been to create a small but cons
 - [`window.fdc3`](ref/Globals#windowfdc3-object) global object and [`fdc3Ready`](ref/Globals#fdc3ready-event) event, for accessing FDC3 operations globally
 - [`DesktopAgent`](ref/DesktopAgent) interface, which exposes FDC3 operations
 - [`Channel`](ref/Channel) interface, for subscribing to specific context channels
-- [`Listener`](ref/Listener) interface, which allows unsubscribing intent or context listeners
+- [`Listener`](ref/Types#listener) interface, which allows unsubscribing intent or context listeners
 
 ## Usage
 
diff --git a/website/versioned_docs/version-1.2/api/ref/Channel.md b/website/versioned_docs/version-1.2/api/ref/Channel.md
@@ -34,6 +34,7 @@ interface Channel {
 #### See also
 
 * [`Context`](Types#context)
+* [`Listener`](Types#listener)
 * [`DesktopAgent.getSystemChannels`](DesktopAgent#getsystemchannels)
 * [`DesktopAgent.getOrCreateChannel`](DesktopAgent#getorcreatechannel)
 * [`DesktopAgent.joinChannel`](DesktopAgent#joinchannel)
@@ -119,7 +120,7 @@ instrumentListener.unsubscribe();
 ```
 
 #### See also
-* [`Listener`](Listener)
+* [`Listener`](Types#listener)
 * [`ContextHandler`](Types#contexthandler)
 * [`broadcast`](#broadcast)
 * [`getCurrentContext`](#getcurrentcontext)
@@ -198,5 +199,4 @@ try {
 #### See also
 * [`ChannelError`](Errors#channelerror)
 * [`broadcast`](#broadcast)
-* [`addContextListener`](#addcontextlistener)
-
+* [`addContextListener`](#addcontextlistener)
diff --git a/website/versioned_docs/version-1.2/api/ref/DesktopAgent.md b/website/versioned_docs/version-1.2/api/ref/DesktopAgent.md
@@ -69,7 +69,7 @@ const contactListener = fdc3.addContextListener('fdc3.contact', contact => { ...
 ```
 
 #### See also
-* [`Listener`](Listener)
+* [`Listener`](Types#listener)
 * [`Context`](Types#context)
 
 
@@ -90,7 +90,7 @@ const listener = fdc3.addIntentListener('StartChat', context => {
 ```
 
 #### See also
-* [`Listener`](Listener)
+* [`Listener`](Types#listener)
 * [`Context`](Types#context)
 
 
diff --git a/website/versioned_docs/version-1.2/api/ref/Listener.md b/website/versioned_docs/version-1.2/api/ref/Listener.md
diff --git a/website/versioned_docs/version-1.2/api/ref/Types.md b/website/versioned_docs/version-1.2/api/ref/Types.md
@@ -51,6 +51,30 @@ Used when attaching listeners for context broadcasts and raised intents.
 * [`DesktopAgent.addContextListener`](DesktopAgent#addcontextlistener)
 * [`Channel.addContextListener`](Channel#addcontextlistener)
 
+## `Listener`
+
+A Listener object is returned when an application subscribes to intents or context broadcasts via the [`addIntentListener`](#addintentlistener) or [`addContextListener`](#addcontextlistener) methods on the [DesktopAgent](DesktopAgent) object.
+
+```typescript
+interface Listener {
+  unsubscribe(): void;
+}
+```
+#### `unsubscribe`
+
+```ts
+unsubscribe(): void;
+```
+
+Allows an application to unsubscribe from listening to intents or context broadcasts.
+
+#### See also
+* [`DesktopAgent.addIntentListener`](DesktopAgent#addintentlistener)
+* [`DesktopAgent.addContextListener`](DesktopAgent#addcontextlistener)
+* [`Channel.addContextListener`](Channel#addcontextlistener)
+* [`ContextHandler`](Types#contexthandler)
+
+
 ## `TargetApp`
 
 ```typescript
diff --git a/website/versioned_sidebars/version-1.2-sidebars.json b/website/versioned_sidebars/version-1.2-sidebars.json
@@ -16,7 +16,6 @@
         "ids": [
           "version-1.2-api/ref/DesktopAgent",
           "version-1.2-api/ref/Channel",
-          "version-1.2-api/ref/Listener",
           "version-1.2-api/ref/Globals",
           "version-1.2-api/ref/Types",
           "version-1.2-api/ref/Metadata",
