Lobby Party Events 0.1.0 documentation
- Protobuf File Spec: lobby.proto
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
members | array | - |
partyCode | string | - |
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
inviteeId | string | - |
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
partyCode | string | - |
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
partyCode | string | - |
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
leftUserId | string | - |
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
kickedUserId | string | - |
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
Name | Type | Description |
---|---|---|
party | object | - |
payload.party
Name | Type | Description |
---|---|---|
partyId | string | - |
leaderId | string | - |
inviterId | string | - |
inviteesId | array | - |
invitationToken | string | - |
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
Name | Type | Description |
---|---|---|
party | partyPayload | - |
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
Name | Type | Description |
---|---|---|
partyId | string | - |
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
Name | Type | Description |
---|---|---|
partyId | string | - |
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
Name | Type | Description |
---|---|---|
party | partyCode | - |
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
Name | Type | Description |
---|---|---|
party | partyCode | - |
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
Name | Type | Description |
---|---|---|
messageId | string | - |
senderId | string | - |
targetId | string | - |
payload | string | - |
Schemas
partyPayload
Name | Type | Description |
---|---|---|
partyId | string | - |
leaderId | string | - |
invitePayload
Name | Type | Description |
---|---|---|
inviterId | string | - |
inviteesId | array | - |
invitationToken | string | - |
platformPayload
Name | Type | Description |
---|---|---|
platform | string | - |
platformUserId | string | - |
partyCode
Name | Type | Description |
---|---|---|
partyId | string | - |
partyCode | string | - |
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 | - |