Skip to main content

Lobby Friends Events 0.1.0 documentation

Published Messages (friendRequests)

The service publishes one of these messages below.

friendRequestSent

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

friendRequestCancelled

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

friendRemoved

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

friendAddedBulk

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

friendRequestAccepted

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

friendRequestRejected

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

Published Messages (incomingFriendRequests)

The service publishes one of these messages below.

friendRequestAccepted

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

friendRequestRejected

Contains fields from event and the following payload.

Example value
{
"payload": {
"relation": {
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"friendId": "4bd6e55f-1d02-40eb-85a5-4e8b566403a4"
}
},
"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

NameTypeDescription
relationfriendRequestsPayload-

Schemas

friendRequestsPayload

NameTypeDescription
userIdstring (uuid)-
friendIdstring (uuid)-

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstringUserId of the operator for this event (optional)
traceIdstring-
sessionIdstring-
spanContextstring-