mirai-core-api/net.mamoe.mirai.utils/ProgressionCallback

ProgressionCallback

interface ProgressionCallback<in S, in P>
Content copied to clipboard

操作进度回调, 可供前端使用, 以提供进度显示.

Since

2.8

See also

Parameters

S

subject, 操作对象, 如 AbsoluteFile

P

progression, 用于提示进度. 如当下载文件时为已下载文件大小字节数 Long.

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
open fun onBegin(subject: S, resource: ExternalResource)
Content copied to clipboard

当操作开始时调用

Link copied to clipboard
open fun onFailure(    subject: S,     resource: ExternalResource,     exception: Throwable)
Content copied to clipboard

当操作以异常失败时调用.

Link copied to clipboard
open fun onFinished(    subject: S,     resource: ExternalResource,     result: Result<P>)
Content copied to clipboard

当操作完成时调用.

Link copied to clipboard
open fun onProgression(    subject: S,     resource: ExternalResource,     progression: P)
Content copied to clipboard

每当有进度更新时调用. 此方法可能会同时被多个线程调用.

Link copied to clipboard
open fun onSuccess(    subject: S,     resource: ExternalResource,     progression: P)
Content copied to clipboard

当操作成功时调用.