የቅጽበታዊ ክስተቶች
የSocket.IO ገጽታ ሙሉ ካርታ: ክፍሎች፣ አገልጋዩ የሚልካቸው ክስተቶች እና ደንበኛው የሚልካቸው። ከአገልጋዩ ምንጮች የተወሰደ ነው።
TypeScript
// Console: a JWT, in auth.token or the Authorization header
const socket = io('https://eu.ws.prodantix.com', {
auth: { token: accessToken },
transports: ['websocket'],
});
// SDK messenger panel: project key + conversation token, one room only
const panel = io('https://eu.ws.prodantix.com', {
auth: { projectKey, conversationToken },
transports: ['websocket'],
});Rooms
An unauthenticated connection is disconnected immediately, with no error frame. A messenger panel is joined to exactly one conversation room and can never subscribe to a project room: a project frame stream is every thread in the project.
| Room | Joined | Who |
|---|---|---|
| tenant:<tenantId> | Automatically at connect | Console connections |
| project:<projectId> | subscribe, authorized against the tenant | Console connections |
| report:<reportId> | subscribe with a reportId, authorized against the tenant | Console connections |
| conversation:<conversationId> | At handshake, via project key + conversation token | SDK messenger panels, this one room only |
Server events
| Event | Room | Fired when | Payload |
|---|---|---|---|
| flagChange | project | A flag is created, edited, archived or unarchived | projectId, key, archived |
| event.ingested | project | The ingest pipeline accepts a batch | events (the rendered batch) |
| workflow.run | project | A workflow run advances | runId, status, currentNodeId |
| conversation.turn | project and conversation | A conversation gains a turn | conversationId, turn |
| reportCommentChange | report | A comment thread on the report starts, gains a reply, an edit, a deletion or a reaction, or is resolved or reopened | projectId, reportId, threadId, change |
| subscribed | the socket | A subscribe was accepted | projectId or reportId |
| unsubscribed | the socket | An unsubscribe completed | projectId or reportId |
| error | the socket | A subscribe was malformed, forbidden or hit a fault | message, and the projectId or reportId when relevant |
Client events
| Event | Payload | Effect |
|---|---|---|
| subscribe | projectId or reportId, never both | Joins the project room, or the report room, after a tenant-ownership check |
| unsubscribe | projectId or reportId, never both | Leaves that room |