Add context filtering to API and improve docs #161
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added overloads for addContextListener that include contextType parameter - Added optional contextType parameter to getContextValue - Rename Channel.addBroadcastListener to Channel.addContextListener for consistency - Change signature of channel context listener to match desktop agent one (remove redundant channel parameter) - Introduce ContextHandler shared type for context handlers like addContextListener. - Add documentation for API changes - Move Channel, Listener, DisplayMetadata and ContextHandler to their own pages - Cleanup of markdown docs
rikoe
force-pushed
the
context-filtering
branch
from
1300a8b to
bab449f
Compare
rikoe
commented
Jan 25, 2020
| * `Error` with a string from the `ChannelError` enumeration. | ||
| */ | ||
| public broadcast(context: Context): Promise<void>; | ||
|
|
||
| /** | ||
| * Returns the last context that was broadcast on this channel. All channels initially have no context, until a | ||
| * window is added to the channel and then broadcasts. If there is not yet any context on the channel, this method | ||
| * will return `null`. The context is also reset back into it's initial context-less state whenever a channel is |
There was a problem hiding this comment.
@nkolba I have removed the second part - seems like an implementation detail to me. FDC3 has no concept of "windows", so it shouldn't be in there.
rikoe
commented
Jan 25, 2020
| @@ -102,34 +103,36 @@ declare class Channel { | |||
| * Note that this function can be used without first joining the channel, allowing applications to broadcast on | |||
| * channels that they aren't a member of. | |||
| * | |||
| * This broadcast will be received by all windows that are members of this channel, *except* for the window that | |||
| * makes the broadcast. This matches the behaviour of the top-level FDC3 `broadcast` function. | |||
There was a problem hiding this comment.
@nkolba I have removed this part - seems like an implementation detail to me. FDC3 has no concept of "windows", so it shouldn't be in there.
nkolba
approved these changes
Jan 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #121.
A summary of the type changes I introduced:
becomes:
The channel parameter is completely redundant here, as we already now what the channel is from the owning object - if a reference is needed, it can be captured with a closure. This brings the handler in line with the one on the desktop agent, which makes for much easier consumption.
Apart from that I have factored out and improved the relevant documentation sections on the website.