Skip to content

Commit

Permalink
Release notes about SectionDisplayDriver breaking changes (#15792)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Zoltán Lehóczky <zoltan.lehoczky@lombiq.com>
Co-authored-by: Mike Alhayek <mike@crestapps.com>
  • Loading branch information
3 people committed Apr 22, 2024
1 parent 332bbca commit 8ddffff
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/docs/releases/1.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,28 @@ In the past, we utilized the injection of `ISmsProvider` for sending SMS message

Additionally, `Twilio` provider is no longer enabled by default. If you want to use Twilio SMS provider, you must enable the provider by visiting the email settings `Configuration` > `Settings` > `Email` and see the `Twilio` tab.

### Display Management

In this release, the signatures of the `UpdateAsync()` method within the `SectionDisplayDriver` base class have undergone modifications. Previously, these signatures accepted the `BuildEditorContext` parameter. However, with this update, all signatures now require the `UpdateEditorContext` instead. This alteration necessitates that every driver inheriting from this class adjusts their contexts accordingly.

Here are the updated signatures:

1. **From:**
`Task<IDisplayResult> UpdateAsync(TModel model, TSection section, IUpdateModel updater, BuildEditorContext context)`
**To:**
`Task<IDisplayResult> UpdateAsync(TModel model, TSection section, IUpdateModel updater, UpdateEditorContext context)`

2. **From:**
`Task<IDisplayResult> UpdateAsync(TSection section, IUpdateModel updater, BuildEditorContext context)`
**To:**
`Task<IDisplayResult> UpdateAsync(TSection section, IUpdateModel updater, UpdateEditorContext context)`

3. **From:**
`Task<IDisplayResult> UpdateAsync(TSection section, BuildEditorContext context)`
**To:**
`Task<IDisplayResult> UpdateAsync(TSection section, UpdateEditorContext context)`

These adjustments ensure compatibility and adherence to the latest conventions within the `SectionDisplayDriver` class.

## Change Logs

Expand Down Expand Up @@ -362,3 +384,4 @@ Enhanced functionality has been implemented, giving developers the ability to co
```csharp
services.Configure<EmailConfirmationTokenProviderOptions>(options => options.TokenLifespan = TimeSpan.FromDays(7));
```

0 comments on commit 8ddffff

Please sign in to comment.