Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release notes about SectionDisplayDriver breaking changes #15792

Merged
merged 4 commits into from
Apr 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -353,3 +375,4 @@ Enhanced functionality has been implemented, giving developers the ability to co
```csharp
services.Configure<EmailConfirmationTokenProviderOptions>(options => options.TokenLifespan = TimeSpan.FromDays(7));
```