Function: location.Delete

Deletes a Location Object. Returns true if successfully deleted or if no such Object existed to begin with.

Syntax

{
	"method": "location.Delete",
	"params": {
		"id": "...",
		"deleteDependents": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Delete( AdvGuid id, std::optional<bool> deleteDependents = std::nullopt );
public Task<bool> DeleteAsync(Guid id, bool? deleteDependents = null, CancellationToken ct = default);
delete(id: string, toDeleteDependents?: boolean | undefined): Promise<boolean>;

Parameters

id : guid

Id of the Location to delete.

deleteDependents : bool optional

If set to true descendant of the Object identified by ‘id’ will also be deleted. If the parameter is not set, the default value is false.

Result : bool

True if successful or no Location with the provided id found.

Remarks

This method requires API write access.