2.2.3.58 EmptyFolderContents
The EmptyFolderContents element is an optional child element of the ItemOperations element in ItemOperations command requests and an optional child element of the Response element in ItemOperations responses. In both contexts, the EmptyFolderContents element identifies the body of the request or response as containing the operation that deletes the contents of a folder.
Elements referenced in this section are defined in the ItemOperations namespace, except where otherwise indicated by the presence of a namespace prefix (as defined in section 2.2.4).
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
ItemOperations command request (section 2.2.1.10) |
ItemOperations (section 2.2.3.94) |
airsync:CollectionId (section 2.2.3.30.3) Options (section 2.2.3.125.3) |
container ([MS-ASDTYPE] section 2.2) |
0...N (optional) |
|
ItemOperations command response |
Response (section 2.2.3.153.4) |
airsync:CollectionId (section 2.2.3.30.3) Status (section 2.2.3.177.8) |
container |
0...N (optional) |
The EmptyFolderContents element enables the client to empty a folder of all its items. The element supports a single child element of the Options element, the DeleteSubFolders element (section 2.2.3.44), which determines whether subfolders contained in the folder are deleted. If the DeleteSubFolders option is not included in the request, the subfolders of the specified airsync:CollectionId are not deleted.
Specifically, clients use EmptyFolderContents to empty the Deleted Items folder. The client can clear out all items in the Deleted Items folder when the user runs out of storage quota (indicated by the return of an HTTP 507 status code from the server).
Protocol Versions
The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.
|
Protocol version |
Element support |
|---|---|
|
2.5 |
|
|
12.0 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |