Skip to content

Commit

Permalink
Update docs/api/ref/DesktopAgent.md
Browse files Browse the repository at this point in the history
Fix type in DesktopAgent docs for addContextListener

Co-authored-by: Matt Jamieson <10372+mattjamieson@users.noreply.github.com>
  • Loading branch information
kriswest and mattjamieson authored Sep 23, 2021
1 parent 4da7898 commit 56bb2f2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api/ref/DesktopAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ addContextListener(contextType: string | null, handler: ContextHandler): Listene
*/
addContextListener(handler: ContextHandler): Listener;
```
Adds a listener for incoming context broadcasts from the Desktop Agent. If the consumer is only interested in a context of a particular type, they can they can specify that type. If the consumer is able to receive context of any type or will inspect types received, then they can pass `null` as the `contextType` parameter to receive all context types.
Adds a listener for incoming context broadcasts from the Desktop Agent. If the consumer is only interested in a context of a particular type, they can specify that type. If the consumer is able to receive context of any type or will inspect types received, then they can pass `null` as the `contextType` parameter to receive all context types.

Context broadcasts are only received from apps that are joined to the same channel as the listening application, hence, if the application is not currently joined to a channel no broadcasts will be received. If this function is called after the app has already joined a channel and the channel already contains context that would be passed to the context listener, then it will be called immediately with that context.

Expand Down

0 comments on commit 56bb2f2

Please sign in to comment.