Skip to content

Commit

Permalink
Update DesktopAgent.md
Browse files Browse the repository at this point in the history
  • Loading branch information
openfin-johans authored Dec 6, 2023
1 parent 9efc8f0 commit 3ad6ec9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.0/api/ref/DesktopAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ addContextListener(contextType: string | null, handler: ContextHandler): Promise

Adds a listener for incoming context broadcasts from the Desktop Agent on the current User Channel. 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 User Channel as the listening application, hence, if the application is not currently joined to a User 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.
Context broadcasts are primarily received from apps that are joined to the same User Channel as the listening application, hence, if the application is not currently joined to a User Channel no broadcasts will be received from channels. If this function is called after the app has already joined a channel and the channel already contains context that matches the type of the context listener, then it will be called immediately and the context passed to the handler function. If `null` was passed as the context type for the listener and the channel contains context, then the handler function will be called immediately with the most recent context - regardless of type.

Optional metadata about each context message received, including the app that originated the message, SHOULD be provided by the Desktop Agent implementation.

Expand Down

0 comments on commit 3ad6ec9

Please sign in to comment.