Chat Events 0.1.0 documentation
- Protobuf File Spec: chat.proto
Published Messages (personalChat)
The service publishes one of these messages below.
personalChatSent
Contains fields from event and the following payload.
Example value
{
"payload": {
"personalChatSent": {
"message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",
"sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
"target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
"payload": "string",
"target_type": "string",
"target_members": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
Name | Type | Description |
---|---|---|
personalChatSent | object | - |
payload.personalChatSent
Name | Type | Description |
---|---|---|
message_id | string (uuid) | - |
sender_id | string (uuid) | - |
target_id | string (uuid) | Can be partyId or userId |
payload | string | - |
target_type | string | - |
target_members | array | - |
Published Messages (chat)
The service publishes one of these messages below.
userConnected
Contains fields from event and the following payload.
Example value
{
"payload": {
"userConnected": {}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
Name | Type | Description |
---|---|---|
userConnected | object | - |
payload.userConnected
This is a free-form object.
userDisconnected
Contains fields from event and the following payload.
Example value
{
"payload": {
"userDisconnected": {
"reason": "string",
"code": 0,
"forced": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
Name | Type | Description |
---|---|---|
userDisconnected | userPayloadDisconnected | - |
userChatRateLimited
Contains fields from event and the following payload.
Example value
{
"payload": {
"userDisconnected": {
"reason": "string",
"code": 0,
"forced": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}
payload
Name | Type | Description |
---|---|---|
userDisconnected | userPayloadDisconnected | - |
Schemas
userPayloadDisconnected
Name | Type | Description |
---|---|---|
reason | string | - |
code | integer | - |
forced | boolean | - |
event
Name | Type | Description |
---|---|---|
id | string | - |
version | integer | - |
name | string | - |
namespace | string | - |
parentNamespace | string | - |
timestamp | string (date-time) | - |
clientId | string | - |
userId | string | UserId of the operator for this event (optional) |
traceId | string | - |
sessionId | string | - |
spanContext | string | - |