EarthSDK
    正在准备搜索索引...

    类 TimingDeprecated

    层级

    • ProcessingDeprecated<void, ProcessType>
      • TimingDeprecated
    索引

    构造函数

    constructor

    属性

    _base cancelFunc? cancelledFunc? completeFunc? delay duration errorFunc? finishedFunc? progressFunc? startFunc? startUpdateFunc _lastMemId

    访问器

    cancelEvent cancelledEvent completeEvent disposers errorEvent finishedEvent isCancelled isCancelling isCompleted isError isFinished isInitial isRunning memId processingID progressEvent startEvent startTime status statusChangedEvent toDestroyEvent

    方法

    _cancel ad autoDispose cancel d destroy destroyImp dispose disposeVar dv isDestroyed reset restart start tdv tryDestory tryDisposeVar

    构造函数

    • 参数

      • duration: number = 1000
      • delay: number = 0
      • startUpdateFunc: undefined | StartUpdateFuncType = defaultStartUpdateFunc

      返回 TimingDeprecated

    属性

    _base

    _base: TimingBase
    cancelFunc?: (cancelError?: CancelError) => void

    进度被取消时的回调函数，表示任务被取消

    cancelledFunc?: (cancelError?: CancelError) => void
    completeFunc?: (value: void) => void

    进度结束时的回调函数，表示任务完成

    delay: number
    duration: number
    errorFunc?: (error: any) => void

    进度执行过程中出现错误，表示任务报错终止

    finishedFunc?: (finishedResult: FinishedResultType<void>) => void

    结束回调，结果可能是完成、错误、取消

    progressFunc?: (value: ProcessType) => void

    进度过程的回调函数，在执行过程中调用，也可能不调用

    startFunc?: (...args: []) => void

    进度启动的回调函数，在用户调用start方法时立即执行

    startUpdateFunc: undefined | StartUpdateFuncType

    静态_lastMemId

    _lastMemId: number = -1

    访问器

    • get cancelEvent(): Event<[void | CancelError]>

      返回 Event<[void | CancelError]>

    • get cancelledEvent(): Event<[void | CancelError]>

      返回 Event<[void | CancelError]>

    • get completeEvent(): Event<[CompleteValueType]>

      返回 Event<[CompleteValueType]>

    • get disposers(): (() => void)[]

      返回 (() => void)[]

    • get errorEvent(): Event<[any]>

      返回 Event<[any]>

    • get finishedEvent(): Event<[FinishedResultType<CompleteValueType>]>

      返回 Event<[FinishedResultType<CompleteValueType>]>

    • get isCancelled(): boolean

      是否已经取消

      返回 boolean

    • get isCancelling(): boolean

      是否正在取消

      返回 boolean

    • get isCompleted(): boolean

      是否能够完成

      返回 boolean

    • get isError(): boolean

      是否发生错误而终止

      返回 boolean

    • get isFinished(): boolean

      是否已经结束，结束有三种可能即：被取消、已完成、错误终止

      返回 boolean

    • get isInitial(): boolean

      是否处于初始化状态

      返回 boolean

    • get isRunning(): boolean

      是否正在运行

      返回 boolean

    • get memId(): number

      返回 number

    • get processingID(): number

      返回 number

    • get progressEvent(): Event<[ProgressValueType]>

      返回 Event<[ProgressValueType]>

    • get startEvent(): Event<StartValueType>

      返回 Event<StartValueType>

    • get startTime(): number

      返回 number

    • get status(): Status

      当前的状态

      返回 Status

    • get statusChangedEvent(): Event<[Status, Status]>

      返回 Event<[Status, Status]>

    • get toDestroyEvent(): Listener

      返回 Listener

    方法

    _cancel

    • _cancel(
          processingID: number,
          cancelError?: CancelError,
      ): undefined | Promise<void>

      参数

      • processingID: number
      • 可选cancelError: CancelError

      返回 undefined | Promise<void>

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 取消操作，需要注意必须是运行状态才可以取消，否则会报错！

      参数

      • 可选cancelError: CancelError
      • processingID: number = ...

      返回 undefined | Promise<void>

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 返回 undefined

    • 请不要重写destroy，请使用destroyImp来重写！

      返回 undefined

    • 返回 void

    • 参数

      • disposeFunc: () => void

      返回 () => void

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 类型参数

      • T extends { destroy(): void }

      参数

      • obj: T

      返回 T

    • 返回 boolean

    • 返回 boolean

    • 如果是完成状态，再重置为初始化状态，但是需要注意，如果是Cancelling状态，则无法完成重置！

      参数

      • 可选cancelError: CancelError

        正在运行的事件，会执行取消操作，cancelError是可以写入的取消原因

      返回 void

    • 重新启动，如果之前是结束状态，则会自动重置状态

      参数

      • 可选cancelError: CancelError
      • ...args: []

      返回 undefined | number

      -1表示没有启动成功，否则表示启动后的processingID

    • 必须是初始化状态才可以启动！

      参数

      • ...args: []

      返回 undefined | number

      -1表示没有启动成功，否则表示启动后的processingID

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    • 返回 undefined

    • 类型参数

      • T extends { tryDestroy(): void }

      参数

      • obj: T

      返回 T

    显示设置

    成员可见性

    目录

    构造函数
    属性
    访问器
    方法