Bot Framework DotNet SDK 4.17.1

Welcome to the July 2022 release of the Bot Framework SDK. This release has been focused on bug fixes and general improvements.

Required changes to existing bots

CosmosDB

This release removed the deprecated CosmosDBStorage and CosmosDBStorageOptions class. Existing bots should use CosmosDBPartitionedStorage and CosmosDBPartitionedStorageOptions instead.

NewtonSoft v13

The update to v13 can cause issues due to NewtonSoft v13 defaulting to a lower MaxDepth than v12. This can cause exceptions while processing some payloads, especially when using Adaptive Dialogs. The following change should be made in your bots Startup.cs to set the MaxDepth to a higher value

services.AddHttpClient().AddControllers().AddNewtonsoftJson(options =>
{
    options.SerializerSettings.MaxDepth = HttpHelper.BotMessageSerializerSettings.MaxDepth;
});

What's Changed

Teams

• Add support for search invoke by @EricDahlvang in #6272
• Add settings.selectedChannel to TeamsChannelData and Type to ChannelInfo and TeamDetails by @EricDahlvang in #6360
• MeetingDetails dates are nullable by @EricDahlvang in #6337
• Add Teams read receipt event by @EricDahlvang in #6356

What's Changed

• Update README by @mrivera-ms in #6279
• Log error message from Streaming web socket response. by @msomanathan in #6283
• Do not check for streaming activity if ServiceUrl is null. by @msomanathan in #6282
• Update WebApi projects target framework to 4.7.2. by @mrivera-ms in #6285
• Add missing badges for 4 packages to readme by @BruceHaley in #6294
• Updated generator BF dependency versions by @tracyboehrer in #6295
• Fix sku values in ARM template by @BruceHaley in #6309
• Update pipeline to coveralls.net v 3.0.0 by @BruceHaley in #6310
• Add oAuthEndpoint to _oAuthClients cache key by @craigjensen in #6298
• [#6229] Add descriptions to ARM template parameters files by @ceciliaavila in #6316
• Add ApplicationName to CosmosDb client options for UserAgent by @EricDahlvang in #6321
• Fix create-botbuilder-parity-issues.yml workflow by @BruceHaley in #6322
• Handle DialogEvents.RepromptDialog in ForEachElement by @EricDahlvang in #6325
• BotBuilder-DotNet-Webex-Functional-Test-yaml intermittently fails by @BruceHaley in #6326
• Fix task 'Verify publish compat results success' by @BruceHaley in #6329
• [#6292] Add unit tests for AzureBlobStorage by @ceciliaavila in #6301
• [#5678] Channels "enumeration" is out of date by @ceciliaavila in #6314
• Changed min requirements for some libraries in the netstandard targetets by @gabog in #6341
• [#6339] Mark deprecated channels as obsolete in Channels enum by @ceciliaavila in #6343
• [#6292] Add unit tests to cover AzureBlobTranscriptStore by @ceciliaavila in #6311
• [#6292] Update CosmosDbPartitionedStorage from Functional to Unit tests by @sw-joelmut in #6302
• [#6292] Update CosmosDbStorage from Functional to Unit tests by @sw-joelmut in #6303
• [#6292] Update Blobs from Functional to Unit tests by @sw-joelmut in #6304
• [#6292] Update Azure Queues from Functional to Unit tests by @sw-joelmut in #6305
• [#5837] Fix sentiment values not being set for None / Unknown intent by @sw-joelmut in #6348
• Retrieve luis recognizer options from DialogContext.State by @EricDahlvang in #6331
• [#6265] NullReferenceException when passing dialog name as variable to Microsoft.BeginDialog by @sw-joelmut in #6338
• [#5977] Update projects to .Net 6 by @ceciliaavila in #6332
• [#5977] Update projects to .Net 6 - Functional Test pipelines by @ceciliaavila in #6333
• [#6292] Remove Azure Functional tests by @ceciliaavila in #6353
• Fix AzureBlobTranscriptStore tests - The specified blob does not exist by @ceciliaavila in #6361
• Add QnAId in value attribute of multi-turn prompts. by @Arsh-Kashyap in #6352
• [#6323] Update generators and vsix to target Net 6 by default by @ceciliaavila in #6334
• Multiple voice tags can now be added in speak field by @ramfattah in #6315
• [#5766] Choice options separator should be multi language by @ceciliaavila in #6366
• Remove unnecessary using directive by @ramfattah in #6362
• [#6392] Bump Newtonsoft.Json from 12.0.3 to 13.0.1 by @ceciliaavila in #6395
• [#6367] Telemetry not working inside child dialogs using latest Adaptive Runtime by @sw-joelmut in #6391
• [#6368] SDK uses deprecated Microsoft.Azure.DocumentDB.Core library by @ceciliaavila in #6370
• [#6392] Bump Newtonsoft.Json from 12.0.3 to 13.0.1 - Set MaxDepth property (1/4) by @ceciliaavila in #6397
• [#6392] Bump Newtonsoft.Json from 12.0.3 to 13.0.1 - Set MaxDepth property (2/4) by @ceciliaavila in #6398
• [#6392] Bump Newtonsoft.Json from 12.0.3 to 13.0.1 - Set MaxDepth property (3/4) by @ceciliaavila in #6399
• [#6392] Bump Newtonsoft.Json from 12.0.3 to 13.0.1 - Set MaxDepth property (4/4) by @ceciliaavila in #6400
• fix: MeetingDetails dates are nullable by @EricDahlvang in #6337
• Fix PublishToCoveralls.ps1 for Windows 2022 by @BruceHaley in #6369
• Add settings.selectedChannel to TeamsChannelData and Type to ChannelInfo and TeamDetails by @EricDahlvang in #6360
• minor: ConversationAccount/IsGroup: Correct typo in docs. by @juharris in #6401
• Add Teams read receipt event by @EricDahlvang in #6356
• Use ActionScope.Actions in ForEachElement by @EricDahlvang in #6394
• Setting NewtonSoft MaxDepth in generators by @tracyboehrer in #6406
• Testing narrow appinsights update by @gabog in #6410
• Catch HttpRequestException in HttpRequest by @EricDahlvang in #6404
• Lowered AppInsights requirements by @gabog in #6412
• [#6355] ContinueDialog fails to find dynamically loaded dialog after bot restart by @sw-joelmut in #6365
• fix for #6407 and #6350 - check existence of blob before uploading to… by @rmt2021 in #6411
• Revert "Multiple voice tags can now be added in speak field (#6315)" by @tracyboehrer in #6402
• feat: update deployment template by @woasishen in #6358
• Corrected VSIX ARM template readmes and project templates to include … by @tracyboehrer in #6418
• [#6306] NamedPipe could not reconnect correctly when disconnected unexpectedly by @ceciliaavila in #6416
• Reasonable ARM Template readme formatting by @tracyboehrer in #6420
• Bump Azure.Storage.Blobs from 12.8.0 to 12.13.0 in /libraries/Microsoft.Bot.Builder.Azure.Blobs by @dependabot in #6424
• Bump Azure.Storage.Queues from 12.3.2 to 12.11.0 in /libraries/Microsoft.Bot.Builder.Azure.Queues by @dependabot in #6423

New Contributors

• @craigjensen made their first contribution in #6298
• @juharris made their first contribution in #6401
• @woasishen made their first contribution in #6358
• @dependabot made their first contribution in #6424

Full Changelog: 4.16.1...4.17.0