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
  • PUB partyChat

Operations

PUB party Operation

Accepts one of the following messages:

Message partyCreated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object allOf	-	-	-	additional properties are allowed
payload.party.members	array<string>	-	-	-	-
payload.party.members (single item)	string	-	-	-	-
payload.party.partyCode	string	-	-	-	-
payload.party.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.0.partyId	string	-	-	-	-
payload.party.0.leaderId	string	-	-	-	-
payload.party.1 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.1.inviterId	string	-	-	-	-
payload.party.1.inviteesId	array<string>	-	-	-	-
payload.party.1.inviteesId (single item)	string	-	-	-	-
payload.party.1.invitationToken	string	-	-	-	-
payload.party.2 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.2.platform	string	-	-	-	-
payload.party.2.platformUserId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object allOf	-	-	-	additional properties are allowed
payload.party.inviteeId	string	-	-	-	-
payload.party.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.0.partyId	string	-	-	-	-
payload.party.0.leaderId	string	-	-	-	-
payload.party.1 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.1.inviterId	string	-	-	-	-
payload.party.1.inviteesId	array<string>	-	-	-	-
payload.party.1.inviteesId (single item)	string	-	-	-	-
payload.party.1.invitationToken	string	-	-	-	-
payload.party.2 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.2.platform	string	-	-	-	-
payload.party.2.platformUserId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object allOf	-	-	-	additional properties are allowed
payload.party.partyCode	string	-	-	-	-
payload.party.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.0.partyId	string	-	-	-	-
payload.party.0.leaderId	string	-	-	-	-
payload.party.1 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.1.inviterId	string	-	-	-	-
payload.party.1.inviteesId	array<string>	-	-	-	-
payload.party.1.inviteesId (single item)	string	-	-	-	-
payload.party.1.invitationToken	string	-	-	-	-
payload.party.2 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.2.platform	string	-	-	-	-
payload.party.2.platformUserId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

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

Message partyUserJoinFailed

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object allOf	-	-	-	additional properties are allowed
payload.party.partyCode	string	-	-	-	-
payload.party.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.0.partyId	string	-	-	-	-
payload.party.0.leaderId	string	-	-	-	-
payload.party.1 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.1.inviterId	string	-	-	-	-
payload.party.1.inviteesId	array<string>	-	-	-	-
payload.party.1.inviteesId (single item)	string	-	-	-	-
payload.party.1.invitationToken	string	-	-	-	-
payload.party.2 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.2.platform	string	-	-	-	-
payload.party.2.platformUserId	string	-	-	-	-
payload.party.3 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.3.errorcode	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

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

Message partyUserLeft

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object allOf	-	-	-	additional properties are allowed
payload.party.leftUserId	string	-	-	-	-
payload.party.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.0.partyId	string	-	-	-	-
payload.party.0.leaderId	string	-	-	-	-
payload.party.1 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.1.inviterId	string	-	-	-	-
payload.party.1.inviteesId	array<string>	-	-	-	-
payload.party.1.inviteesId (single item)	string	-	-	-	-
payload.party.1.invitationToken	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object allOf	-	-	-	additional properties are allowed
payload.party.kickedUserId	string	-	-	-	-
payload.party.0 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.0.partyId	string	-	-	-	-
payload.party.0.leaderId	string	-	-	-	-
payload.party.1 (allOf item)	object	-	-	-	additional properties are allowed
payload.party.1.inviterId	string	-	-	-	-
payload.party.1.inviteesId	array<string>	-	-	-	-
payload.party.1.inviteesId (single item)	string	-	-	-	-
payload.party.1.invitationToken	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object	-	-	-	additional properties are allowed
payload.party.partyId	string	-	-	-	-
payload.party.leaderId	string	-	-	-	-
payload.party.inviterId	string	-	-	-	-
payload.party.inviteesId	array<string>	-	-	-	-
payload.party.inviteesId (single item)	string	-	-	-	-
payload.party.invitationToken	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object	-	-	-	additional properties are allowed
payload.party.partyId	string	-	-	-	-
payload.party.leaderId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
party	object	-	-	-	additional properties are allowed
party.partyId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
party	object allOf	-	-	-	additional properties are allowed
party.partyId	string	-	-	-	-
party.0 (allOf item)	object	-	-	-	additional properties are allowed
party.0.platform	string	-	-	-	-
party.0.platformUserId	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object	-	-	-	additional properties are allowed
payload.party.partyId	string	-	-	-	-
payload.party.partyCode	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.party	object	-	-	-	additional properties are allowed
payload.party.partyId	string	-	-	-	-
payload.party.partyCode	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
party	object	-	-	-	additional properties are allowed
party.messageId	string	-	-	-	-
party.senderId	string	-	-	-	-
party.targetId	string	-	-	-	-
party.payload	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	UserId of the operator for this event (optional)	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

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