Skip to content

Commit

Permalink
Modify the Action description to make it clearer
Browse files Browse the repository at this point in the history
Co-authored-by: Kris West <kris.west@interop.io>
  • Loading branch information
symphony-jean-michael and kriswest authored Oct 9, 2024
1 parent f9fc79a commit eba30bb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion schemas/context/action.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"type": { "const": "fdc3.action" },
"action": {
"title": "Action Type",
"description": "The **action** field indicates the type of action:\n- **raiseIntent** : If no action or `raiseIntent` is specified, then the current default behaviour will be used with `fdc3.raiseIntent` / `fdc3.raiseIntentForContext`\n- **broadcast** : If `broadcast` action is specified, it will call `fdc3.getOrCreateChannel(channelId)`to retrieve the channel, then broadcast the context to that channel with `channel.broadcast(context)`. If no channel has been specified, it will try to broadcast to the current channel (`fdc3.getCurrentChannel()`)",
"description": "The **action** field indicates the type of action:\n- **raiseIntent** : If no action or `raiseIntent` is specified, then `fdc3.raiseIntent` or `fdc3.raiseIntentForContext` will be called with the specified context (and intent if given).\n- **broadcast** : If `broadcast` and a `channelId` are specified then `fdc3.getOrCreateChannel(channelId)` is called to retrieve the channel and broadcast the context to it with `channel.broadcast(context)`. If no `channelId` is been specified, the context should be braodcast to the current channel (`fdc3.broadcast()`)",
"type": "string",
"enum": [
"broadcast",
Expand Down

0 comments on commit eba30bb

Please sign in to comment.