Lobby Friends Events 0.1.0 documentation

• Protobuf File Spec: lobby.proto

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

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

Name	Type	Description
relation	friendRequestsPayload	-

Schemas

friendRequestsPayload

Name	Type	Description
userId	string (uuid)	-
friendId	string (uuid)	-

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	-