From 1535cc1c5f53aa275b056ea81ceec9255bbb5c78 Mon Sep 17 00:00:00 2001 From: Kris West Date: Tue, 31 Aug 2021 18:09:33 +0100 Subject: [PATCH] Clarifying behavior of fdc3.addContextListener when not joined to a channel --- docs/api/spec.md | 2 +- website/versioned_docs/version-1.2/api/spec.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/spec.md b/docs/api/spec.md index 0d525548f..248054fa7 100644 --- a/docs/api/spec.md +++ b/docs/api/spec.md @@ -221,7 +221,7 @@ There are two types of channels, which are functionally identical, but have diff ### Joining Channels Apps can join channels. An app can only be joined to one channel at a time. When an app joins a channel it will automatically recieve the current context for that channel. -When an app is joined to a channel, calls to fdc3.broadcast and listeners added through fdc3.addContextListener will be routed to that channel. If an app is not joined to a channel these methods will be no-ops, but apps can still choose to listen and broadcast to specific channels via the methods on the `Channel` class. +When an app is joined to a channel, calls to `fdc3.broadcast` and listeners added through `fdc3.addContextListener` will be routed to that channel. If an app is not joined to a channel `fdc3.broadcast` will be a no-op and handler functions added with `fdc3.addContextListener` will not receive any broadcasts. However, apps can still choose to listen and broadcast to specific channels via the methods on the `Channel` class. It is possible that a call to join a channel could be rejected. If for example, the desktop agent wanted to implement controls around what data apps can access. diff --git a/website/versioned_docs/version-1.2/api/spec.md b/website/versioned_docs/version-1.2/api/spec.md index 08cc40bfe..796c65a7e 100644 --- a/website/versioned_docs/version-1.2/api/spec.md +++ b/website/versioned_docs/version-1.2/api/spec.md @@ -222,7 +222,7 @@ There are two types of channels, which are functionally identical, but have diff ### Joining Channels Apps can join channels. An app can only be joined to one channel at a time. When an app joins a channel it will automatically recieve the current context for that channel. -When an app is joined to a channel, calls to fdc3.broadcast and listeners added through fdc3.addContextListener will be routed to that channel. If an app is not joined to a channel these methods will be no-ops, but apps can still choose to listen and broadcast to specific channels via the methods on the `Channel` class. +When an app is joined to a channel, calls to `fdc3.broadcast` and listeners added through `fdc3.addContextListener` will be routed to that channel. If an app is not joined to a channel `fdc3.broadcast` will be a no-op and handler functions added with `fdc3.addContextListener` will not receive any broadcasts. However, apps can still choose to listen and broadcast to specific channels via the methods on the `Channel` class. It is possible that a call to join a channel could be rejected. If for example, the desktop agent wanted to implement controls around what data apps can access.