API_Specs/PlayStreamCommonEventModels.json at master · thirdkindgames/API_Specs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
{
  "ParentTypes": [
    {
      "Group": "none",
      "Classes": [
        {
          "name": "CommonEventData",
          "className": "CustomEventData",
          "classNameSpace": "PlayFab.PlayStreamCommonEvent.Models",
          "assembly": "PlayFab.PlayStreamCommonEvent.Models",
          "properties": [
            {
              "name": "EventId",
              "description": "PlayFab-assigned unique identifier for this event.",
              "jsontype": "String",
              "actualtype": "String",
              "optional": true
            },
            {
              "name": "EventNamespace",
              "description": "The assigned namespacing for this event. For example: 'com.myprogram.ads'",
              "jsontype": "String",
              "actualtype": "String",
              "optional": true
            },
            {
              "name": "EventName",
              "description": "The name of this event.",
              "jsontype": "String",
              "actualtype": "String",
              "optional": false
            },
            {
              "name": "EntityType",
              "description": "The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required    that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.",
              "jsontype": "String",
              "actualtype": "String",
              "optional": false
            },
            {
              "name": "EntityId",
              "description": "The identifier for the entity (title, player, etc) to which this event applies.",
              "jsontype": "String",
              "actualtype": "String",
              "optional": true
            },
            {
              "name": "SourceType",
              "description": "The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).",
              "jsontype": "String",
              "actualtype": "SourceType",
              "isenum": true,
              "optional": true
            },
            {
              "name": "Source",
              "description": "The name of the source of this PlayStream event; will be PlayFab if the event originated from us.",
              "jsontype": "String",
              "actualtype": "String",
              "optional": true
            },
            {
              "name": "Timestamp",
              "description": "The time (in UTC) associated with this event.",
              "jsontype": "String",
              "actualtype": "DateTime",
              "optional": true
            },
            {
              "name": "History",
              "description": "The history of events associated with this event. This is set in cases where an event has generated children events via a trigger action.",
              "collection": "array",
              "jsontype": "Object",
              "actualtype": "PlayStreamEventHistory",
              "isclass": true,
              "optional": true
            },
            {
              "name": "CustomTags",
              "description": "Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.",
              "collection": "map",
              "jsontype": "String",
              "actualtype": "String",
              "optional": true
            },
            {
              "name": "Reserved",
              "description": "Reserved exclusively for PlayFab internal use.",
              "jsontype": "Object",
              "actualtype": "object",
              "optional": true
            }
          ]
        }
      ]
    }
  ],
  "ChildTypes": [
    {
      "name": "SourceType",
      "className": "SourceType",
      "classNameSpace": "PlayFab.PlayStreamCommonEvent.Models",
      "assembly": "PlayFab.PlayStreamCommonEvent.Models",
      "isenum": true,
      "enumvalues": [
        {
          "name": "Admin"
        },
        {
          "name": "BackEnd"
        },
        {
          "name": "GameClient"
        },
        {
          "name": "GameServer"
        },
        {
          "name": "Partner"
        }
      ]
    },
    {
      "name": "PlayStreamEventHistory",
      "className": "PlayStreamEventHistory",
      "classNameSpace": "PlayFab.PlayStreamCommonEvent.Models",
      "assembly": "PlayFab.PlayStreamCommonEvent.Models",
      "properties": [
        {
          "name": "ParentTriggerId",
          "description": "The ID of the trigger that caused this event to be created.",
          "jsontype": "String",
          "actualtype": "String",
          "optional": true
        },
        {
          "name": "ParentEventId",
          "description": "The ID of the previous event that caused this event to be created by hitting a trigger.",
          "jsontype": "String",
          "actualtype": "String",
          "optional": true
        },
        {
          "name": "TriggeredEvents",
          "description": "If true, then this event was allowed to trigger subsequent events in a trigger.",
          "jsontype": "Boolean",
          "actualtype": "Boolean",
          "optional": false
        }
      ]
    }
  ]
}