Skip to main content
Version: 2.1

broadcast

Desktop Agent bridging message exchange for a broadcast() API call on the DesktopAgent or a Channel. Generated by API calls:

caution

Broadcasts on a PrivateChannel have a separate message exchange, see PrivateChannel.broadcast.

Message Exchange Type: Request only

E.g.

fdc3.broadcast(contextObj);

or

(await fdc3.getOrCreateChannel("myChannel")).broadcast(contextObj)

Message exchange

Request format

Request message schemas

Example

Outward message to the DAB:

// agent-A -> DAB
{
"type": "broadcastRequest",
"payload": {
"channelId": "myChannel",
"context": { /*contextObj*/ }
},
"meta": {
"requestUuid": "<requestUuid>",
"timestamp": "2022-03-...",
"source": {
"appId": "agentA-app1",
"instanceId": "c6ad5174-6f78-4582-8e96-728d93a4d7d7"
}
}
}

which it repeats on to agent-B AND agent-C with the source.desktopAgent metadata added.

// DAB -> agent-B
// DAB -> agent-C
{
"type": "broadcastRequest",
"payload": {
"channelId": "myChannel",
"context": { /*contextObj*/}
},
"meta": {
"requestUuid": "<requestUuid>",
"timestamp": "2020-03-...",
"source": {
"appId": "agentA-app1",
"instanceId": "c6ad5174-6f78-4582-8e96-728d93a4d7d7",
"desktopAgent": "agent-A" //added by DAB
}
}
}