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

AbsoluteFolder

@NotStableForInheritance
expect interface AbsoluteFolder : AbsoluteFileFolder

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

Since

2.8

See also

@NotStableForInheritance
actual interface AbsoluteFolder : AbsoluteFileFolder

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

Since

2.8

See also

Types

Link copied to clipboard
expect object Companion
actual object Companion

Functions

Link copied to clipboard
expect abstract suspend fun children(): Flow<AbsoluteFileFolder>

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

actual abstract suspend fun children(): Flow<AbsoluteFileFolder>

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

Link copied to clipboard
abstract suspend fun childrenStream(): <Error class: unknown class><AbsoluteFileFolder>

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

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

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

actual abstract suspend fun createFolder(name: String): AbsoluteFolder

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

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

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

abstract suspend fun delete(): Boolean

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

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

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

abstract suspend fun exists(): Boolean

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

Link copied to clipboard
expect abstract suspend fun files(): Flow<AbsoluteFile>

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

actual abstract suspend fun files(): Flow<AbsoluteFile>

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

Link copied to clipboard
abstract suspend fun filesStream(): <Error class: unknown class><AbsoluteFile>

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

Link copied to clipboard
expect abstract suspend fun folders(): Flow<AbsoluteFolder>

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

actual abstract suspend fun folders(): Flow<AbsoluteFolder>

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

Link copied to clipboard
abstract suspend fun foldersStream(): <Error class: unknown class><AbsoluteFolder>

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

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

当该目录为空时返回 true.

actual open fun isEmpty(): Boolean

当该目录为空时返回 true.

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

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

abstract suspend fun refresh(): Boolean

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

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

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

actual abstract suspend override fun refreshed(): AbsoluteFolder?

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

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

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

abstract suspend fun renameTo(newName: String): Boolean

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

Link copied to clipboard
expect abstract suspend fun resolveAll(path: String): Flow<AbsoluteFileFolder>

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

actual abstract suspend fun resolveAll(path: String): Flow<AbsoluteFileFolder>

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

Link copied to clipboard
abstract suspend fun resolveAllStream(path: String): <Error class: unknown class><AbsoluteFileFolder>

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

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

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

actual abstract suspend fun resolveFileById(id: String, deep: Boolean = false): AbsoluteFile?

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

Link copied to clipboard
expect abstract suspend fun resolveFiles(path: String): Flow<AbsoluteFile>

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

actual abstract suspend fun resolveFiles(path: String): Flow<AbsoluteFile>

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

Link copied to clipboard
abstract suspend fun resolveFilesStream(path: String): <Error class: unknown class><AbsoluteFile>

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

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

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

actual abstract suspend fun resolveFolder(name: String): AbsoluteFolder?

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

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

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

actual abstract suspend fun resolveFolderById(id: String): AbsoluteFolder?

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

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

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

actual abstract suspend fun uploadNewFile(filepath: String, content: ExternalResource, callback: ProgressionCallback<AbsoluteFile, Long>? = null): AbsoluteFile

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

Properties

Link copied to clipboard
abstract val absolutePath: String

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

abstract val absolutePath: String

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

Link copied to clipboard
abstract val contact: FileSupported

该对象所属 FileSupported

abstract val contact: FileSupported

该对象所属 FileSupported

Link copied to clipboard
expect abstract val contentsCount: Int

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

actual abstract val contentsCount: Int

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

Link copied to clipboard
@get:JvmStatic
val AbsoluteFileFolder.extension: String

返回文件的后缀名. 如 foo.txt 返回 txt.

Link copied to clipboard
abstract val id: String

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

abstract val id: String

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

Link copied to clipboard
abstract val isFile: Boolean

表示远程文件时返回 true.

abstract val isFile: Boolean

表示远程文件时返回 true.

Link copied to clipboard
abstract val isFolder: Boolean

表示远程目录时返回 true.

abstract val isFolder: Boolean

表示远程目录时返回 true.

Link copied to clipboard
abstract val lastModifiedTime: Long

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

abstract val lastModifiedTime: Long

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

Link copied to clipboard
abstract val name: String

文件名或目录名.

abstract val name: String

文件名或目录名.

Link copied to clipboard
@get:JvmStatic
val AbsoluteFileFolder.nameWithoutExtension: String

返回去掉文件后缀的文件名. 如 foo.txt 返回 foo.

Link copied to clipboard
abstract val parent: AbsoluteFolder?

上级 AbsoluteFileFolder.

abstract val parent: AbsoluteFolder?

上级 AbsoluteFileFolder.

Link copied to clipboard
abstract val uploaderId: Long

上传者 ID.

abstract val uploaderId: Long

上传者 ID.

Link copied to clipboard
abstract val uploadTime: Long

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

abstract val uploadTime: Long

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