Skip to main content

Lobby Party Events 0.1.0 documentation

Published Messages (party)

The service publishes one of these messages below.

partyCreated

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"members": [
"string"
],
"partyCode": "string",
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "string",
"platform": "string",
"platformUserId": "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

NameTypeDescription
partyobject-
payload.party
NameTypeDescription
membersarray-
partyCodestring-

partyUserInvited

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"inviteeId": "string",
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "string",
"platform": "string",
"platformUserId": "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

NameTypeDescription
partyobject-
payload.party
NameTypeDescription
inviteeIdstring-

partyUserJoined

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"partyCode": "string",
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "string",
"platform": "string",
"platformUserId": "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

NameTypeDescription
partyobject-
payload.party
NameTypeDescription
partyCodestring-

partyUserJoinFailed

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"partyCode": "string",
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "string",
"platform": "string",
"platformUserId": "string",
"errorcode": 0
}
},
"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
partyobject-
payload.party
NameTypeDescription
partyCodestring-

partyUserLeft

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"leftUserId": "string",
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "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

NameTypeDescription
partyobject-
payload.party
NameTypeDescription
leftUserIdstring-

partyUserKicked

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"kickedUserId": "string",
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "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

NameTypeDescription
partyobject-
payload.party
NameTypeDescription
kickedUserIdstring-

partyUserReject

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"partyId": "string",
"leaderId": "string",
"inviterId": "string",
"inviteesId": [
"string"
],
"invitationToken": "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

NameTypeDescription
partyobject-
payload.party
NameTypeDescription
partyIdstring-
leaderIdstring-
inviterIdstring-
inviteesIdarray-
invitationTokenstring-

partyUserNewLeader

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"partyId": "string",
"leaderId": "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

NameTypeDescription
partypartyPayload-

partyDeleteCode

Contains fields from event and the following payload.

Example value
{
"party": {
"partyId": "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"
}

party

NameTypeDescription
partyIdstring-

partyJoinViaCode

Contains fields from event and the following payload.

Example value
{
"party": {
"partyId": "string",
"platform": "string",
"platformUserId": "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"
}

party

NameTypeDescription
partyIdstring-

partyGenerateCode

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"partyId": "string",
"partyCode": "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

NameTypeDescription
partypartyCode-

partyGetCode

Contains fields from event and the following payload.

Example value
{
"payload": {
"party": {
"partyId": "string",
"partyCode": "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

NameTypeDescription
partypartyCode-

Published Messages (partyChat)

The service publishes one of these messages below.

partyChatSent

Contains fields from event and the following payload.

Example value
{
"party": {
"messageId": "string",
"senderId": "string",
"targetId": "string",
"payload": "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"
}

party

NameTypeDescription
messageIdstring-
senderIdstring-
targetIdstring-
payloadstring-

Schemas

partyPayload

NameTypeDescription
partyIdstring-
leaderIdstring-

invitePayload

NameTypeDescription
inviterIdstring-
inviteesIdarray-
invitationTokenstring-

platformPayload

NameTypeDescription
platformstring-
platformUserIdstring-

partyCode

NameTypeDescription
partyIdstring-
partyCodestring-

event

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