メインコンテンツまでスキップ

Session Notification Events 0.1.0 documentation

備考

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://session-service
  • Protobuf File Spec: session.proto

Table of Contents

Operations

PUB session Operation

Message onPartyCreated

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

PUB sessionNotification Operation

Message sessionNotification

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

PUB sessionEvent Operation

Message OnSessionEnded

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

PUB mpv2SessionHistory Operation

Accepts one of the following messages:

Message GameSessionEndedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionInvitedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionInvitedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionMembersChangedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionKickedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionCreatedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionUpdatedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionRejectedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionDSStatusChangedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionCodeChangedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message GameSessionCodeRevokedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyCreatedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyUpdatedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyKickedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyLeaveEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyInvitedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyRejectedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyJoinedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

Message PartyMembersChangedEvent

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.userIdsarray<string>----
payload.userIds (single item)string----
payload.namespacestring----
payload.topicNamestring----
payload.messagestring----
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
userIdstring----
traceIdstring----
sessionIdstring----
spanContextstring----

Examples of payload (generated)

{
"payload": {
"userIds": [
"string"
],
"namespace": "string",
"topicName": "string",
"message": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}