Method SwitchVersionAsync
SwitchVersionAsync(String, CancellationToken)
Asynchronously switches all connected feature tables to the new version.
Declaration
public Task SwitchVersionAsync(string versionName, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.String | versionName | The name of the version to connect to. |
CancellationToken | cancellationToken | A CancellationToken with which to cancel the operation if required. |
Returns
Type | Description |
---|---|
Task | A task that represents the switching to the specified version. |
Remarks
An error is thrown if:
- The service isn't branch versioned.
- No version exists with the supplied name.
- Any of the ConnectedTables have unapplied edits.
Check the result of HasLocalEdits() before attempting to switch versions, to make sure all changes are saved to the service or discarded from the local cache. Use the ApplyEditsAsync(), ApplyEditsAsync(CancellationToken) or UndoLocalEditsAsync() methods as appropriate to save or discard changes before switching versions.
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
ArcGISServerException | No version exists with the supplied name. |
InvalidOperationException | Any of the ConnectedTables have unapplied edits. |
BranchVersioningNotSupportedByServiceException | The service isn't branch versioned. |
Applies to
Platforms and versions
Target | Versions |
---|---|
.NET Standard 2.0 | 100.12 - 100.15 |
.NET 6.0 | 100.13 - 100.15 |
.NET 6.0 Windows | 100.13 - 100.15 |
.NET Framework | 100.12 - 100.15 |
.NET 5 | 100.12 |
.NET Core 3.1 | 100.12 |
Xamarin.Android | 100.12 - 100.15 |
Xamarin.iOS | 100.12 - 100.15 |
UWP | 100.12 - 100.14 |
SwitchVersionAsync(String)
Asynchronously switches all connected feature tables to the new version.
Declaration
public Task SwitchVersionAsync(string versionName)
Parameters
Type | Name | Description |
---|---|---|
System.String | versionName | The name of the version to connect to. |
Returns
Type | Description |
---|---|
Task | A task that represents the switching to the specified version. |
Remarks
An error is thrown if:
- The service isn't branch versioned.
- No version exists with the supplied name.
- Any of the ConnectedTables have unapplied edits.
Check the result of HasLocalEdits() before attempting to switch versions, to make sure all changes are saved to the service or discarded from the local cache. Use the ApplyEditsAsync(), ApplyEditsAsync(CancellationToken) or UndoLocalEditsAsync() methods as appropriate to save or discard changes before switching versions.
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
ArcGISServerException | No version exists with the supplied name. |
InvalidOperationException | Any of the ConnectedTables have unapplied edits. |
BranchVersioningNotSupportedByServiceException | The service isn't branch versioned. |
Applies to
Platforms and versions
Target | Versions |
---|---|
.NET Standard 2.0 | 100.10 - 100.15 |
.NET 6.0 | 100.13 - 100.15 |
.NET 6.0 Windows | 100.13 - 100.15 |
.NET Framework | 100.10 - 100.15 |
.NET 5 | 100.10 - 100.12 |
.NET Core 3.1 | 100.10 - 100.12 |
Xamarin.Android | 100.10 - 100.15 |
Xamarin.iOS | 100.10 - 100.15 |
UWP | 100.10 - 100.15 |