Skip to content

Commit 3bbce2c

Browse files
authored
Merge pull request #1690 from bingenito/dotnet-async-unsubscribe-docs
docs(dotnet): mark IListener.Unsubscribe as async (Task) in Types reference
2 parents 6c6ec46 + c8ac204 commit 3bbce2c

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
2424

2525
### Fixed
2626

27+
* Updated .NET API documentation for IListener.Unsubscribe to be async for 2.2 and current. ([#1690](https://github.com/finos/FDC3/pull/1690))
2728
* Corrected the property set in WCP1Hello by getAgent that indicates whether an intent resolver is needed. ([#1684](https://github.com/finos/FDC3/issues/1684))
2829
* Add unit tests to the fdc3-context package for validating context examples are valid schema.
2930
* Revert schema of `fdc3.timeRange` context type back to use anyOf in place of oneOf for the `startTime` and `endTime` property combinations. This will allow existence of one of either, or both, and pass schema validation. When defined with oneOf, validation would fail due to multiple entries being valid and it could not identify which to apply. ([#1592](https://github.com/finos/FDC3/issues/1592))

website/docs/api/ref/Types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ interface Listener {
338338
```csharp
339339
interface IListener
340340
{
341-
void Unsubscribe();
341+
Task Unsubscribe();
342342
}
343343
```
344344

@@ -368,7 +368,7 @@ unsubscribe(): Promise<void>;
368368
<TabItem value="dotnet" label=".NET">
369369

370370
```csharp
371-
void Unsubscribe();
371+
Task Unsubscribe();
372372
```
373373

374374
</TabItem>

website/versioned_docs/version-2.2/api/ref/Types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ interface Listener {
271271
```csharp
272272
interface IListener
273273
{
274-
void Unsubscribe();
274+
Task Unsubscribe();
275275
}
276276
```
277277

@@ -291,7 +291,7 @@ unsubscribe(): Promise<void>;
291291
<TabItem value="dotnet" label=".NET">
292292

293293
```csharp
294-
void Unsubscribe();
294+
Task Unsubscribe();
295295
```
296296

297297
</TabItem>

0 commit comments

Comments
 (0)