3.1.5.3.8 list documents

  • Article

The list documents request is used by the client to request a list of files, folders, and sites contained in a given folder.

Tokens

service_name: This parameter is deprecated. See service_name in section 3.1.5.3.1.

folderList: The folderList parameter is a METADICT containing the names of folders as the keys and the corresponding time stamps of type TIME for the client's cached metadata for those folders as the values. The client SHOULD send the time stamps for the folders' metadata if it has cached this information. If a folder's name and time stamp is missing from the folderList parameter, the server MUST return that folder's contents with all available metadata. Otherwise, the server MUST return all available metadata for only those files, folders, and subsites that have changed since the time stamp recorded in the folder list. For files, folders, and subsites that have not changed, the server SHOULD return an empty METADICT to indicate that the client's cache is still valid. The client MUST interpret an empty METADICT as an indication of validity.

The following example of a value for the folderList parameter requests metadata for all files in the root folder of the website and in the images folder that have a time stamp later than the specified dates and times. For other files in these folders, only the file name and an empty METADICT are included in the response. For all other folders within the initialUrl parameter, all available metadata MUST be returned.

[;TX|06 Apr 2006 20:03:02 -0000;images;TX|05 Apr 2006

20:03:02 -0000]

initialUrl: A URL-STRING containing the URL of the folder from which documents are listed. This MUST be a service-relative URL.

listBorders: A BOOLEAN value that specifies whether the contents of the shared borders directory that contains shared border pages is to be listed. If TRUE, the contents are listed; if FALSE, they SHOULD NOT be listed. The server SHOULD honor this parameter, but the client MUST NOT rely on it.<38>

listChildWebs: A BOOLEAN value that specifies whether the server response includes the names of the child site folders in the urldirs return value. If TRUE, and the listFolders parameter is also sent as TRUE, the names SHOULD be included; if FALSE, they SHOULD NOT be included. If the client sends this parameter as TRUE, the client SHOULD also send the listFolders parameter as TRUE. The server SHOULD ignore a TRUE value for this parameter if the listFolders parameter is not also TRUE. The server SHOULD honor this parameter, but the client MUST NOT rely on it.<39>

listDerived: A BOOLEAN value that specifies whether the list of files in the derived documents folder is included in the response. If TRUE, the list of files SHOULD be included as part of the response; if FALSE, they SHOULD NOT be included. The server SHOULD honor this parameter, but the client MUST NOT rely on it.<40>

listExplorerDocs: A BOOLEAN value that specifies if task list files (_vti_pvt/_x_todo.htm and _vti_pvt/_x_todoh.htm) are listed. If TRUE, the files MAY be listed. If FALSE, they MUST NOT be listed. FrontPage Server Extensions Remote Protocol clients MUST NOT send this parameter; the server SHOULD ignore it.<41>

listFiles: A BOOLEAN value that specifies whether the client requests information about the files in each directory that appears in the response. If TRUE, the server MUST include the document_list return value; if FALSE, the server SHOULD exclude the document_list return value. The server SHOULD use a default value of TRUE for this parameter unless the client specifies otherwise<42>

listFolders: A BOOLEAN value that specifies whether the server response includes the names and metadata of folders under the URL specified by the initialUrl parameter. If TRUE, the directory names and metainformation SHOULD be included; if FALSE, they MUST NOT be included. The server SHOULD use a default value of TRUE for this parameter unless the client specifies otherwise.

The server SHOULD honor this parameter, but the client MUST NOT rely on it.

listHiddenDocs: A BOOLEAN value that specifies whether hidden documents in a site are listed. If true, the documents SHOULD be listed; if false, they SHOULD NOT be listed. The server SHOULD honor this parameter, but the client MUST NOT rely on it.

listIncludeParent: A BOOLEAN value that specifies whether an entry for the initialUrl field is included in the server response. If TRUE, the entry SHOULD be included; if FALSE, it SHOULD NOT be included. The server SHOULD honor this parameter, but the client MUST NOT rely on it.

listLinkInfo: For semantics, see section 3.1.5.3.1. The server SHOULD use a default value of TRUE for this parameter unless the client specifies otherwise.

listRecurse: A BOOLEAN value that specifies whether the client requests the server to recursively list the subfolders of folders under the URL specified by the initialUrl parameter. If TRUE, the subfolders SHOULD be listed; if FALSE, they SHOULD NOT be listed. The server SHOULD use a default value of TRUE for this parameter unless the client specifies otherwise. If listRecurse is TRUE, all subfolders of that folder are listed; otherwise, only the immediate subfolders are listed. The server SHOULD honor this parameter, but the client MUST NOT rely on it.

listThickets: A BOOLEAN value that specifies whether thicket supporting files and folders are included in the server response. If TRUE, the supporting files and folders SHOULD be included; if FALSE, they SHOULD NOT be included. The server SHOULD use a default value of TRUE for this parameter unless the client specifies otherwise. The server SHOULD honor this parameter, but the client MUST NOT rely on it.

platform: A STRING specifying the operating system of the client. This parameter MUST NOT be passed by clients conforming to the FrontPage Server Extensions Remote Protocol.

validateWelcomeNames: For semantics, see section 3.1.5.3.1.

URL

FPAuthorScriptUrl

Return Values

document_list: A DOCUMENT-LIST-RETURN-TYPE (section 2.2.2.2.13) that the server SHOULD omit if the listFiles parameter was sent as FALSE. If this value is returned, the server MUST list the names and metadata for the requested set of documents specified by the parameters of the request.<43>

bot_list: A DOCUMENT-LIST-RETURN-TYPE return value that MUST NOT be included when the platform parameter is not sent. Because clients conforming to the FrontPage Server Extensions Remote Protocol MUST NOT send this parameter, the server need not support this return value.<44>

urldirs: A VECTOR-URL-DIRECTORY containing the names and metadata about folders and root directories of subsites. The server MUST omit this return value if the listFolders parameter was sent as FALSE. If this value is returned, the server MUST enumerate the folders and websites specified by parameters of the request.