forked from BotBuilderCommunity/botbuilder-community-dotnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAlexaSchema.cs
More file actions
392 lines (292 loc) · 9.5 KB
/
Copy pathAlexaSchema.cs
File metadata and controls
392 lines (292 loc) · 9.5 KB
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
using System;
using System.Collections.Generic;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Linq;
namespace Bot.Builder.Community.Adapters.Alexa
{
public class AlexaRequestBody
{
public string Version { get; set; }
public AlexaSession Session { get; set; }
public AlexaContext Context { get; set; }
[JsonConverter(typeof(AlexaRequestConvertor))]
public IAlexaRequest Request { get; set; }
public Type GetAlexaRequestType()
{
if (Request is AlexaIntentRequest)
return typeof(AlexaIntentRequest);
if (Request is AlexaLaunchRequest)
return typeof(AlexaLaunchRequest);
if (Request is AlexaSessionEndRequest)
return typeof(AlexaSessionEndRequest);
return null;
}
}
public class AlexaSession
{
/** A boolean value indicating whether this is a new session. */
public bool New { get; set; }
/** A string that represents a unique identifier per a user's active session. */
public string SessionId { get; set; }
/** A map of key-value pairs. */
public IDictionary<string, string> Attributes { get; set; }
/** An object containing an application ID. This is used to verify that the request was intended for your service. */
public AlexaApplication Application { get; set; }
/** An object that describes the user making the request. */
public AlexaUser User { get; set; }
}
public class AlexaContext
{
public AlexaSystem System { get; set; }
public AlexaAudioPlayer AudioPlayer { get; set; }
}
public class AlexaSystem
{
public string ApiAccessToken { get; set; }
public string ApiEndpoint { get; set; }
public AlexaApplication Application { get; set; }
public AlexaDevice Device { get; set; }
public AlexaUser User { get; set; }
}
public class AlexaApplication
{
public string ApplicationId { get; set; }
}
public class AlexaDevice
{
public string DeviceId { get; set; }
public AlexaSupportedInterfaces SupportedInterfaces { get; set; }
}
public class AlexaSupportedInterfaces
{
[JsonExtensionData]
public IDictionary<string, JToken> Interfaces { get; set; }
}
public class AlexaUser
{
public string UserId { get; set; }
public string AccessToken { get; set; }
}
public class AlexaAudioPlayer
{
public string Token{ get; set; }
public int OffsetInMilliseconds { get; set; }
[JsonConverter(typeof(StringEnumConverter))]
public AlexaPlayerActivityTypes PlayerActivity { get; set; }
}
public enum AlexaPlayerActivityTypes
{
IDLE,
PAUSED,
PLAYING,
BUFFER_UNDERRUN,
FINISHED,
STOPPED
}
public class AlexaResponseBody
{
public string Version { get; set; }
public IDictionary<string, string> SessionAttributes { get; set; }
public AlexaResponse Response { get; set; }
public object Reprompt { get; internal set; }
}
public class AlexaResponse
{
public AlexaOutputSpeech OutputSpeech { get; set; }
public AlexaCard Card { get; set; }
public Reprompt Reprompt { get; set; }
public bool ShouldEndSession { get; set; }
public object[] Directives { get; set; }
}
public class Reprompt
{
public AlexaOutputSpeech OutputSpeech { get; set; }
}
public class AlexaOutputSpeech
{
[JsonConverter(typeof(StringEnumConverter))]
public AlexaOutputSpeechType Type { get; set; }
public string Text { get; set; }
public string Ssml { get; set; }
}
public enum AlexaOutputSpeechType
{
SSML,
PlainText
}
public class AlexaCard
{
[JsonConverter(typeof(StringEnumConverter))]
public AlexaCardType Type { get; set; }
public string Title { get; set; }
public string Content { get; set; }
public string Text { get; set; }
public AlexaCardImage Image { get; set; }
public string[] Permissions { get; set; }
}
public class AlexaCardImage
{
public string SmallImageUrl { get; set; }
public string LargeImageUrl { get; set; }
}
public enum AlexaCardType
{
Simple,
Standard,
LinkAccount,
AskForPermissionsConsent
}
public interface IAlexaRequest
{
string Type { get; set; }
string Timestamp { get; set; }
string RequestId { get; set; }
string Locale { get; set; }
}
public class AlexaLaunchRequest : IAlexaRequest
{
public string Type { get; set; }
public string Timestamp { get; set; }
public string RequestId { get; set; }
public string Locale { get; set; }
}
public class AlexaIntentRequest : IAlexaRequest
{
[JsonConverter(typeof(StringEnumConverter))]
public AlexaDialogState DialogState { get; set; }
public AlexaIntent Intent { get; set; }
public string Type { get; set; }
public string Timestamp { get; set; }
public string RequestId { get; set; }
public string Locale { get; set; }
}
public class AlexaSessionEndRequest : IAlexaRequest
{
public string Reason { get; set; }
public AlexaError Error { get; set; }
public string Type { get; set; }
public string Timestamp { get; set; }
public string RequestId { get; set; }
public string Locale { get; set; }
}
public class AlexaError
{
public string Type { get; set; }
public string Message { get; set; }
}
public enum AlexaDialogState
{
STARTED,
IN_PROGRESS,
COMPLETED
}
public class AlexaIntent
{
public string Name { get; set; }
public string ConfirmationStatus { get; set; }
public Dictionary<string,AlexaSlot> Slots { get; set; }
}
public class AlexaSlot
{
public string Name { get; set; }
public string Value { get; set; }
[JsonConverter(typeof(StringEnumConverter))]
public AlexaConfirmationState ConfirmationStatus { get; set; }
public AlexaResolution Resolution { get; set; }
}
public class AlexaResolution
{
public List<AlexaResolutionAuthority> ResolutionsPerAuthority { get; set; }
}
public class AlexaResolutionAuthority
{
public string Authority { get; set; }
public AlexaResolutionStatus Status { get; set; }
public List<AlexaResolvedValue> Values { get; set; }
}
public class AlexaResolutionStatus
{
[JsonConverter(typeof(StringEnumConverter))]
public AlexaResolutionStatusCode Code { get; set; }
}
public class AlexaResolvedValue
{
public AlexaResolvedValueValue Value { get; set; }
}
public class AlexaResolvedValueValue
{
public string Name { get; set; }
public string Id { get; set; }
}
public enum AlexaConfirmationState
{
NONE,
CONFIRMED,
DENIED
}
public enum AlexaResolutionStatusCode
{
ER_SUCCESS_MATCH,
ER_SUCCESS_NO_MATCH,
ER_ERROR_TIMEOUT,
ER_ERROR_EXCEPTION
}
public class AlexaDirectiveRequest
{
public DirectiveHeader Header { get; set; }
public DirectiveContent Directive { get; set; }
public class DirectiveHeader
{
public string RequestId { get; set; }
}
public class DirectiveContent
{
public string Type { get; set; }
public string Speech { get; set; }
}
}
public class AlexaRequestConvertor : JsonConverter
{
public override bool CanWrite => false;
public override bool CanRead => true;
public override bool CanConvert(Type objectType)
{
return objectType == typeof(IAlexaRequest);
}
public override void WriteJson(JsonWriter writer,
object value, JsonSerializer serializer)
{
throw new InvalidOperationException("Use default serialization.");
}
public override object ReadJson(JsonReader reader,
Type objectType, object existingValue,
JsonSerializer serializer)
{
var jsonObject = JObject.Load(reader);
var profession = default(IAlexaRequest);
switch (jsonObject["type"].Value<string>())
{
case AlexaRequestTypes.LaunchRequest:
profession = new AlexaLaunchRequest();
break;
case AlexaRequestTypes.SessionEndedRequest:
profession = new AlexaSessionEndRequest();
break;
case AlexaRequestTypes.IntentRequest:
profession = new AlexaIntentRequest();
break;
}
serializer.Populate(jsonObject.CreateReader(), profession);
return profession;
}
}
// Item names for AlexaGetUserProfile
public class AlexaCustomerItem
{
public const string Name = "name";
public const string GivenName = "givenName";
public const string Email = "email";
public const string MobileNumber = "mobileNumber";
}
}