Session Notification Events 0.1.0 documentation

Protobuf File Spec: session.proto

Published Messages (session)

The service publishes one of these messages below.

onPartyCreated

Contains fields from and the following payload.

Example value

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

id

This is a free-form object.

version

This is a free-form object.

name

This is a free-form object.

namespace

This is a free-form object.

parentNamespace

This is a free-form object.

timestamp

This is a free-form object.

userId

This is a free-form object.

traceId

This is a free-form object.

sessionId

This is a free-form object.

spanContext

This is a free-form object.

Published Messages (sessionNotification)

The service publishes one of these messages below.

sessionNotification

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

Published Messages (sessionEvent)

The service publishes one of these messages below.

OnSessionEnded

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

Published Messages (mpv2SessionHistory)

The service publishes one of these messages below.

GameSessionEndedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionInvitedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionInvitedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionMembersChangedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionKickedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionCreatedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionUpdatedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionRejectedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionDSStatusChangedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionCodeChangedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

GameSessionCodeRevokedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyCreatedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyUpdatedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyKickedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyLeaveEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyInvitedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyRejectedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyJoinedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

PartyMembersChangedEvent

Contains fields from event and the following payload.

Example value

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

payload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

Schemas

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
userId	string	-
traceId	string	-
sessionId	string	-
spanContext	string	-

notificationPayload

Name	Type	Description
userIds	array	-
namespace	string	-
topicName	string	-
message	string	-

Session Notification Events 0.1.0 documentation

Published Messages (session)​

onPartyCreated​

id​

version​

name​

namespace​

parentNamespace​

timestamp​

userId​

traceId​

sessionId​

spanContext​

Published Messages (sessionNotification)​

sessionNotification​

payload​

Published Messages (sessionEvent)​

OnSessionEnded​

payload​

Published Messages (mpv2SessionHistory)​

GameSessionEndedEvent​

payload​

GameSessionInvitedEvent​

payload​

GameSessionInvitedEvent​

payload​

GameSessionMembersChangedEvent​

payload​

GameSessionKickedEvent​

payload​

GameSessionCreatedEvent​

payload​

GameSessionUpdatedEvent​

payload​

GameSessionRejectedEvent​

payload​

GameSessionDSStatusChangedEvent​

payload​

GameSessionCodeChangedEvent​

payload​

GameSessionCodeRevokedEvent​

payload​

PartyCreatedEvent​

payload​

PartyUpdatedEvent​

payload​

PartyKickedEvent​

payload​

PartyLeaveEvent​

payload​

PartyInvitedEvent​

payload​

PartyRejectedEvent​

payload​

PartyJoinedEvent​

payload​

PartyMembersChangedEvent​

payload​

Schemas​

event​

notificationPayload​

On this page

Published Messages (session)

onPartyCreated

id

version

name

namespace

parentNamespace

timestamp

userId

traceId

sessionId

spanContext

Published Messages (sessionNotification)

sessionNotification

payload

Published Messages (sessionEvent)

OnSessionEnded

payload

Published Messages (mpv2SessionHistory)

GameSessionEndedEvent

payload

GameSessionInvitedEvent

payload

GameSessionInvitedEvent

payload

GameSessionMembersChangedEvent

payload

GameSessionKickedEvent

payload

GameSessionCreatedEvent

payload

GameSessionUpdatedEvent

payload

GameSessionRejectedEvent

payload

GameSessionDSStatusChangedEvent

payload

GameSessionCodeChangedEvent

payload

GameSessionCodeRevokedEvent

payload

PartyCreatedEvent

payload

PartyUpdatedEvent

payload

PartyKickedEvent

payload

PartyLeaveEvent

payload

PartyInvitedEvent

payload

PartyRejectedEvent

payload

PartyJoinedEvent

payload

PartyMembersChangedEvent

payload

Schemas

event

notificationPayload