Skip to main content

Lobby Party Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

  • Specification ID: http://lobby-party-service
  • Protobuf File Spec: party.proto

Table of Contents

Operations

PUB party Operation

Accepts one of the following messages:

Message partyCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.membersarray<string>----
payload.party.members (single item)string----
payload.party.partyCodestring----
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
payload.party.2 (allOf item)object---additional properties are allowed
payload.party.2.platformstring----
payload.party.2.platformUserIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyUserInvited

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.inviteeIdstring----
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
payload.party.2 (allOf item)object---additional properties are allowed
payload.party.2.platformstring----
payload.party.2.platformUserIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyUserJoined

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
payload.party.2 (allOf item)object---additional properties are allowed
payload.party.2.platformstring----
payload.party.2.platformUserIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"party": {
"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"
}

Message partyUserJoinFailed

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
payload.party.2 (allOf item)object---additional properties are allowed
payload.party.2.platformstring----
payload.party.2.platformUserIdstring----
payload.party.3 (allOf item)object---additional properties are allowed
payload.party.3.errorcodeinteger----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"party": {
"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"
}

Message partyUserLeft

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.leftUserIdstring----
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyUserKicked

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.kickedUserIdstring----
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyUserReject

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyallOf---additional properties are allowed
payload.party.0 (allOf item)object---additional properties are allowed
payload.party.0.partyIdstring----
payload.party.0.leaderIdstring----
payload.party.1 (allOf item)object---additional properties are allowed
payload.party.1.inviterIdstring----
payload.party.1.inviteesIdarray<string>----
payload.party.1.inviteesId (single item)string----
payload.party.1.invitationTokenstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyUserNewLeader

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyobject---additional properties are allowed
payload.party.partyIdstring----
payload.party.leaderIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyDeleteCode

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
partyobject---additional properties are allowed
party.partyIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyJoinViaCode

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
partyallOf---additional properties are allowed
party.partyIdstring----
party.0 (allOf item)object---additional properties are allowed
party.0.platformstring----
party.0.platformUserIdstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyGenerateCode

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyobject---additional properties are allowed
payload.party.partyIdstring----
payload.party.partyCodestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

Message partyGetCode

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
payload----additional properties are allowed
payload.partyobject---additional properties are allowed
payload.party.partyIdstring----
payload.party.partyCodestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}

PUB partyChat Operation

Message partyChatSent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)allOf---additional properties are allowed
partyobject---additional properties are allowed
party.messageIdstring----
party.senderIdstring----
party.targetIdstring----
party.payloadstring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstringUserId of the operator for this event (optional)---
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"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"
}