IAzureCosmosDbDeleteDevice Method

Deletes a DeviceDto from the database

Definition

Namespace: MobileTrack.DataContainers.Cosmos
Assembly: MobileTrack.DataContainers (in MobileTrack.DataContainers.dll) Version: 0.7+1dadc87dcf0a0f837e19a3ce2deb7c1cd85375d1
C#Request Example
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

Exceptions

UnauthorizedAccessExceptionThrown if the user deletedBy did not have the correct permissions
ArgumentNullExceptionThrown if device or deletedBy was

See Also