FileBrowserServices.Delete Method

FileBrowserServicesDelete Method

Ingeniux CMS Web Services API

Delete a Asset file or folder. Note that deleting a folder will remove all files below, so use with caution.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<DeleteOutput> Delete(
	DeleteInput data
)

Public Function Delete ( 
	data As DeleteInput
) As XHRServiceResponseGeneric(Of DeleteOutput)

public:
virtual XHRServiceResponseGeneric<DeleteOutput^>^ Delete(
	DeleteInput^ data
) sealed

abstract Delete : 
        data : DeleteInput -> XHRServiceResponseGeneric<DeleteOutput> 
override Delete : 
        data : DeleteInput -> XHRServiceResponseGeneric<DeleteOutput>

Parameters

data

Type: DeleteInput

The information on the deletion

Examples

Sample JSON request deleting folder

JavaScript

Copy

{
    "data": {
        "type": "File",
        "relativePath": "Documents/Testfolder",
        "folderPath": "Documents/Testfolder",
        "pickedNames": [],
        "isFolder": true
    }
}

Examples

Sample JSON request deleting file

JavaScript

Copy

{
    "data": {
        "type": "File",
        "relativePath": "Documents",
        "folderPath": "Documents",
        "pickedNames": ["free-infamous-second-son-hd-desktop-wallpaper (17).jpg"],
        "isFolder": false
    }
}

Return Value

Type: XHRServiceResponseGenericDeleteOutput

The information of actual deletion

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "fileNames": ["free-infamous-second-son-hd-desktop-wallpaper%20(17).jpg"]
    }
}

Reference

FileBrowserServices Class

IngeniuxCMService Namespace