Foxit PDF SDK for HarmonyOS  3.0
FoxitPDFViewCtrl.Task Class Referenceabstract

Public Member Functions

 canCancel ()
 
 cancel ()
 
 constructor (cb) prepare()
 
 errorCode ()
 
abstract execute ()
 
 exeSuccess ()
 
 extErrorCode ()
 
 finish ()
 
 getPriority ()
 
 getStatus ()
 
 isCanceled ()
 
 isModify ()
 
 setPriority (priority)
 
 setThreadPriority (priority)
 

Detailed Description

抽象任务类,需要用户继承这个类来实现具体的功能。 用户可以通过 PDFViewCtrlModel.addTask来添加任务,在任务队列中,任务的执行是顺序的,下个任务必须要等到上个任务结束后才会执行, 同时,任务开始前,可以指定任务的优先级

Member Function Documentation

◆ canCancel()

FoxitPDFViewCtrl.Task.canCancel ( )

判断任务是否允许取消

Returns
返回true表示任务允许取消,false表示不可取消

◆ cancel()

FoxitPDFViewCtrl.Task.cancel ( )

取消任务方法

◆ constructor()

FoxitPDFViewCtrl.Task.constructor ( cb  )

任务准备方法,在任务执行前被调用

子类可重写此方法进行资源预加载等准备工作

◆ errorCode()

FoxitPDFViewCtrl.Task.errorCode ( )

获取主错误码

Returns
返回任务执行产生的主错误码(整型值)

◆ execute()

abstract FoxitPDFViewCtrl.Task.execute ( )
pure virtual

抽象任务执行方法

子类必须实现此方法定义具体任务逻辑 执行过程中应定期检查 isCanceled 状态

Returns
返回 Promise 对象,解析结果可以是:
  • TaskResultModel 任务结果模型
  • boolean 表示执行成功与否
  • null|void 表示无返回值

◆ exeSuccess()

FoxitPDFViewCtrl.Task.exeSuccess ( )

判断任务是否执行成功

Returns
成功时返回true,否则返回false

◆ extErrorCode()

FoxitPDFViewCtrl.Task.extErrorCode ( )

获取扩展错误码

Returns
返回任务执行的扩展错误码(整型值)

◆ finish()

FoxitPDFViewCtrl.Task.finish ( )

标记任务完成

触发回调 CallBack 通知任务执行结果

◆ getPriority()

FoxitPDFViewCtrl.Task.getPriority ( )

获取任务优先级

Returns
返回 PRIORITY 枚举表示的任务优先级

◆ getStatus()

FoxitPDFViewCtrl.Task.getStatus ( )

获取任务当前状态

Returns
返回 STATUS 枚举表示的任务状态

◆ isCanceled()

FoxitPDFViewCtrl.Task.isCanceled ( )

获取任务取消状态

Returns
返回true表示任务已被取消,false表示未取消

◆ isModify()

FoxitPDFViewCtrl.Task.isModify ( )

判断任务是否修改了文档内容

Returns
返回true表示任务修改了文档,false表示未修改

◆ setPriority()

FoxitPDFViewCtrl.Task.setPriority ( priority  )

设置任务优先级

Parameters
priority使用 PRIORITY 枚举值设置任务优先级

◆ setThreadPriority()

FoxitPDFViewCtrl.Task.setThreadPriority ( priority  )

设置任务线程优先级

Parameters
priority线程优先级,使用 PRIORITY 枚举值