FileBrowserServices.GetFileList Method

FileBrowserServicesGetFileList Method

Ingeniux CMS Web Services API

Retrieve the list of file in specified folder

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<FileBrowserFileListing> GetFileList(
	string dir,
	string type
)

Public Function GetFileList ( 
	dir As String,
	type As String
) As XHRServiceResponseGeneric(Of FileBrowserFileListing)

public:
virtual XHRServiceResponseGeneric<FileBrowserFileListing^>^ GetFileList(
	String^ dir, 
	String^ type
) sealed

abstract GetFileList : 
        dir : string * 
        type : string -> XHRServiceResponseGeneric<FileBrowserFileListing> 
override GetFileList : 
        dir : string * 
        type : string -> XHRServiceResponseGeneric<FileBrowserFileListing>

Parameters

dir: Type: SystemString
The folder to get files listing for
Examples

"Images/homeslider"
type: Type: SystemString
The type of asset this folder is folder. The choices are "File", "Image", "Media", "Prebuilt", "Stylesheet"

Return Value

Type: XHRServiceResponseGenericFileBrowserFileListing

List of files in the specified folder

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "headers": [{
            "bodyTextAlign": "left",
            "label": "#",
            "minWidth": "30px",
            "type": "fileType"
        }, {
            "bodyTextAlign": "left",
            "label": "Name",
            "minWidth": "120px",
            "type": "string"
        }, {
            "bodyTextAlign": "left",
            "label": "Size (KB)",
            "minWidth": "90px",
            "type": "float"
        }, {
            "bodyTextAlign": "left",
            "label": "Type",
            "minWidth": "90px",
            "type": "string"
        }, {
            "bodyTextAlign": "left",
            "label": "Date Modified",
            "minWidth": "100px",
            "type": "xmldate"
        }],
        "rows": [{
            "attributes": [{
                "Key": "filePath",
                "Value": "aeroplane.png"
            }],
            "elements": ["png", "aeroplane.png", "137.25", "PNG image", "20130122T12:07:28"]
        }, {
            "attributes": [{
                "Key": "filePath",
                "Value": "balloon.png"
            }],
            "elements": ["png", "balloon.png", "134.92", "PNG image", "20130122T12:07:28"]
        }, {
            "attributes": [{
                "Key": "filePath",
                "Value": "bg-green.png"
            }],
            "elements": ["png", "bg-green.png", "0.95", "PNG image", "20130215T01:55:28"]
        }, {
            "attributes": [{
                "Key": "filePath",
                "Value": "bg-heading.png"
            }],
            "elements": ["png", "bg-heading.png", "0.93", "PNG image", "20130104T19:06:54"]
        }, {
            "attributes": [{
                "Key": "filePath",
                "Value": "bg-sky.png"
            }],
            "elements": ["png", "bg-sky.png", "0.54", "PNG image", "20130122T12:07:28"]
        }, {
            "attributes": [{
                "Key": "filePath",
                "Value": "bg-text.png"
            }],
            "elements": ["png", "bg-text.png", "0.92", "PNG image", "20130202T17:55:54"]
        }, {
            "attributes": [{
                "Key": "filePath",
                "Value": "sequence-logo.png"
            }],
            "elements": ["png", "sequence-logo.png", "2.59", "PNG image", "20130122T12:07:28"]
        }]
    }
}

Reference

FileBrowserServices Class

IngeniuxCMService Namespace