AzureCosmosDbDeleteDashboard Method

Deletes DashboardDto from the database.

Definition

Namespace: MobileTrack.DataContainers.Cosmos
Assembly: MobileTrack.DataContainers (in MobileTrack.DataContainers.dll) Version: 0.8+34f1bbd8dc6b32752cfce829cbed66e15113d7ba

C#Request Example

public Task DeleteDashboard(
	DashboardDto dashboard,
	UserSessionData deletedBy,
	bool forceDelete = false,
	CancellationToken cancellationToken = default
)

Parameters

dashboard DashboardDto: Dashboard to delete
deletedBy UserSessionData: User deleting the item
forceDelete Boolean (Optional): True if delete permanently
cancellationToken CancellationToken (Optional): Cancellation token (optional)

Return Value

Task
Task completion

Implements

IAzureCosmosDbDeleteDashboard(DashboardDto, UserSessionData, Boolean, CancellationToken)

Exceptions

UnauthorizedAccessException	Thrown if the user deletedBy did not have the correct permissions
ArgumentNullException	Thrown if dashboard or deletedBy was