mirai-core-api/net.mamoe.mirai.contact.file/AbsoluteFolder

AbsoluteFolder

@NotStableForInheritance
interface AbsoluteFolder : AbsoluteFileFolder
Content copied to clipboard

绝对目录标识. 精确表示一个远程目录. 不会受同名文件或目录的影响.

Since

2.8

See also

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun children(): <ERROR CLASS><AbsoluteFileFolder>
Content copied to clipboard

获取该目录下所有文件和子目录列表.

Link copied to clipboard
abstract suspend fun childrenStream(): <ERROR CLASS><AbsoluteFileFolder>
Content copied to clipboard

获取该目录下所有文件和子目录列表.

Link copied to clipboard
abstract suspend fun createFolder(name: String): AbsoluteFolder
Content copied to clipboard

创建一个名称为 name 的子目录. 返回成功创建的或已有的子目录. 当目标目录已经存在时则直接返回该目录.

Link copied to clipboard
abstract suspend fun delete(): Boolean
Content copied to clipboard

删除远程文件或目录. 只会根据 id 精确地删除一个文件或目录, 不会删除其他同名文件或目录. 成功时返回 true, 当远程文件或目录不存在时返回 false.

Link copied to clipboard
abstract suspend fun exists(): Boolean
Content copied to clipboard

查询该远程文件或目录是否还存在于服务器.

Link copied to clipboard
abstract suspend fun files(): <ERROR CLASS><AbsoluteFile>
Content copied to clipboard

获取该目录下所有文件列表.

Link copied to clipboard
abstract suspend fun filesStream(): <ERROR CLASS><AbsoluteFile>
Content copied to clipboard

获取该目录下所有文件列表.

Link copied to clipboard
abstract suspend fun folders(): <ERROR CLASS><AbsoluteFolder>
Content copied to clipboard

获取该目录下所有子目录列表.

Link copied to clipboard
abstract suspend fun foldersStream(): <ERROR CLASS><AbsoluteFolder>
Content copied to clipboard

获取该目录下所有子目录列表.

Link copied to clipboard
open fun isEmpty(): Boolean
Content copied to clipboard

当该目录为空时返回 true.

Link copied to clipboard
abstract suspend fun refresh(): Boolean
Content copied to clipboard

更新当前 AbsoluteFileFolder 对象的文件或目录信息 (lastModifiedTime, absolutePath 等). 成功时返回 true, 当远程文件或目录不存在时返回 false.

Link copied to clipboard
abstract suspend override fun refreshed(): AbsoluteFolder?
Content copied to clipboard

返回更新了文件或目录信息 (lastModifiedTime 等) 的, 指向相同文件的 AbsoluteFileFolder. 不会更新当前 AbsoluteFileFolder 对象.

Link copied to clipboard
abstract suspend fun renameTo(newName: String): Boolean
Content copied to clipboard

重命名远程文件或目录, 并且修改当前(this) AbsoluteFileFolder 的 name. 成功时返回 true, 当远程文件或目录不存在时返回 false.

Link copied to clipboard
abstract suspend fun resolveAll(path: String): <ERROR CLASS><AbsoluteFileFolder>
Content copied to clipboard

根据路径获取指向的所有路径为 path 的文件和目录列表. 同时支持相对路径和绝对路径. 支持获取子目录内的文件和目录.

Link copied to clipboard
abstract suspend fun resolveAllStream(path: String): <ERROR CLASS><AbsoluteFileFolder>
Content copied to clipboard

根据路径获取指向的所有路径为 path 的文件和目录列表. 同时支持相对路径和绝对路径. 支持获取子目录内的文件和目录.

Link copied to clipboard
abstract suspend fun resolveFileById(id: String, deep: Boolean = false): AbsoluteFile?
Content copied to clipboard

精确获取 AbsoluteFile.id 为 id 的文件. 在目标文件不存在时返回 null. 当 deep 为 true 时还会深入子目录查找.

Link copied to clipboard
abstract suspend fun resolveFiles(path: String): <ERROR CLASS><AbsoluteFile>
Content copied to clipboard

根据路径获取指向的所有路径为 path 的文件列表. 同时支持相对路径和绝对路径. 支持获取子目录内的文件.

Link copied to clipboard
abstract suspend fun resolveFilesStream(path: String): <ERROR CLASS><AbsoluteFile>
Content copied to clipboard

根据路径获取指向的所有路径为 path 的文件列表. 同时支持相对路径和绝对路径. 支持获取子目录内的文件.

Link copied to clipboard
abstract suspend fun resolveFolder(name: String): AbsoluteFolder?
Content copied to clipboard

获取一个已存在的名称为 name 的子目录. 当该名称的子目录不存在时返回 null.

Link copied to clipboard
abstract suspend fun resolveFolderById(id: String): AbsoluteFolder?
Content copied to clipboard

获取一个已存在的 AbsoluteFileFolder.id 为 id 的子目录. 当该名称的子目录不存在时返回 null.

Link copied to clipboard
abstract override fun toString(): String
Content copied to clipboard
Link copied to clipboard
abstract suspend fun uploadNewFile(    filepath: String,     content: ExternalResource,     callback: ProgressionCallback<AbsoluteFile, Long>? = null): AbsoluteFile
Content copied to clipboard

上传一个文件到该目录, 返回上传成功的文件标识.

Properties

Link copied to clipboard
abstract val absolutePath: String
Content copied to clipboard

绝对路径, 如 /foo/bar.txt.

Link copied to clipboard
abstract val contact: FileSupported
Content copied to clipboard

该对象所属 FileSupported

Link copied to clipboard
abstract val contentsCount: Int
Content copied to clipboard

当前快照中文件数量, 当有文件更新时(上传/删除文件) 该属性不会更新.

Link copied to clipboard
abstract val id: String
Content copied to clipboard

文件或目录的 ID, 即 fileId 或 folderId. 该属性由服务器维护, 通常唯一且持久.

Link copied to clipboard
abstract val isFile: Boolean
Content copied to clipboard

表示远程文件时返回 true.

Link copied to clipboard
abstract val isFolder: Boolean
Content copied to clipboard

表示远程目录时返回 true.

Link copied to clipboard
abstract val lastModifiedTime: Long
Content copied to clipboard

远程文件或目录的最后修改时间戳, 单位秒.

Link copied to clipboard
abstract val name: String
Content copied to clipboard

文件名或目录名.

Link copied to clipboard
abstract val parent: AbsoluteFolder?
Content copied to clipboard

上级 AbsoluteFileFolder.

Link copied to clipboard
abstract val uploaderId: Long
Content copied to clipboard

上传者 ID.

Link copied to clipboard
abstract val uploadTime: Long
Content copied to clipboard

远程文件或目录的创建时间, 时间戳秒.