Session.DeleteAsync(Object, CancellationToken) Method

Asynchronously deletes the specified persistent object and its aggregated objects from persistent storage.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task DeleteAsync(
    object theObject,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function DeleteAsync(
    theObject As Object,
    cancellationToken As CancellationToken = Nothing
) As Task

Parameters

Name	Type	Description
theObject	Object	An object which represents the persistent object to delete.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Type	Description
Task	A Task that deletes the specified persistent object and its aggregated objects from persistent storage.

Remarks

Below is an example of using the DeleteAsync method. Here, session is the Session instance.

C#

using System.Threading.Tasks;
// ...
private async Task DeleteOrder() {
    await this.UnitOfWork.DeleteAsync(this.CurrentOrder);
}

VB.NET

Imports System.Threading.Tasks
' ...
Private Async Function DeleteOrder() As Task
    Await Me.UnitOfWork.DeleteAsync(Me.CurrentOrder)
End Function

If a persistent object has the DeferredDeletionAttribute, the DeleteAsync method doesn’t actually remove the underlying database record. Instead, it marks the record as deleted and writes a reference to this object for later use by the Session.PurgeDeletedObjects method. You should clear all references to the object to be deleted. Otherwise, the object will not be purged. To persist the deleted state, save the object by calling its XPBaseObject.Save method.

If the DeferredDeletionAttribute isn’t specified, the DeleteAsync method removes the underlying database record which corresponds to the persistent object unless there are references to this object.

Note

When an object with Deferred Deletion enabled is deleted, it is removed from associated collections. Associations cannot be recreated automatically when you restore a deleted object. This behavior is by design, because the Deferred Deletion feature is not intended for object restoration, but for overcoming complex foreign index constraints at the database level.