AzureCosmosDbDeleteDevice Method

Deletes a DeviceDto from the database

Definition

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

C#Request Example

public Task DeleteDevice(
	DeviceDto device,
	UserSessionData deletedBy,
	bool forceDelete = false,
	CancellationToken cancellationToken = default
)

Parameters

device DeviceDto: Device to be deleted
deletedBy UserSessionData: User deleting the EnvironmentDto
forceDelete Boolean (Optional): Whether to force deletion of the device
cancellationToken CancellationToken (Optional): Cancellation token

Return Value

Task
Task completion

Implements

IAzureCosmosDbDeleteDevice(DeviceDto, UserSessionData, Boolean, CancellationToken)

Exceptions

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