名前

型

説明

path

String, 必須

フォルダのパスを指定します。パスについてはこちらをご覧ください。

mask

String

ファイル、フォルダ名のマスクを指定します。デフォルトは*です。

limit

Integer

最大取得件数を指定します。デフォルトは100です。

offset

Integer

取得開始オフセット、先頭から取得する場合0を指定します。デフォルトは0です。

attributes

String

追加して取得したい属性があれば指定します。カンマ区切りで属性名を列挙してください。以下で指定する属性名の他、実存する拡張属性名を指定できます。デフォルトは空です。

description - 概要（FileBlog）

comment - コメント（FileBlog）

physicalpath - フルパス（Windowsパス形式）

is_readonly - 読み取り専用かどうか？（NTFS）

is_hidden - 隠し属性（NTFS）

is_sysfile - システム属性（NTFS）

is_archive - アーカイブ属性（NTFS）

lastaccesstime - 最終アクセス日時（NTFS）
 
Ver3.10.0.4 ～ 利用可能
openable - そのファイル/フォルダを開く権限を持っているか？（FileBlog）
has_thumbnail - サムネイル画像が生成済みか？ただし生成済みでもopenableでない場合falseが返ります（FileBlog）
page_count - ファイルのページ数。プレビュー未作成や作成対象でない場合-1。ただしプレビュー生成済みでもopenableでない場合-1が返ります（FileBlog）

Ver3.12.0.16 ～ 利用可能
pathcaption - 表示用のパス文字列（名前を含む）です。pathとname値の連結した後とほぼ同値ですが、ドキュメントルートエイリアス値の代わりにドキュメントルート表示名が割り当てられます。

orderby

String

ソート（昇順）に使用するフィールド名を指定します。 以下の値を使用できます。指定しない場合はファイルシステムが返した順番になります。

name

text

strcmplogical

size

creationtime

lastwritetime

extension

orderbydescending

String

ソート（降順）に使用するフィールド名を指定します。orderbyが指定されていた場合は無視されます。デフォルトはnameです。

orderpriority

String

folder,file,bothのいずれかを指定できます。昇順時においてファイルとフォルダのどちらを上にもってくるか？を指定します。bothならば考慮せずファイルとフォルダを混在させます。デフォルトはfolderです。

名前

値

説明

entries

配列

entry(ファイル、フォルダ情報)の配列です。

name

String

ファイル、フォルダ名です。

path

String

親フォルダのパスです。

creationtime

Timestamp

作成日時(ISO8601 形式)です。

lastwritetime

Timestamp

更新日時(ISO8601 形式)です。

is_dir

Boolean

ディレクトリの場合はtrueが返されます。

size

Integer

ファイルサイズです。フォルダの場合は-1になります。

attributes

リクエスト時にattributesを指定した時にだけ（指定した属性のみ）返されます。

total_count

Integer

ヒットした件数です。entryの数ではなく条件にマッチした総数,この値を上限にlimit,offset値を指定してpagingが可能です。