Class BackgroundTasks

Background task and progress class manager. Access via the global app.backgroundTasks.

BackgroundTasks

Hierarchy (view full)

Constructors

constructor

Properties

asJSON count id objectType onChanged persistentID statusInfo title

Methods

createNew doCut getClassName getPersistentJSON getValue getVisibleCount isMarked locked setMarked terminateAll

Events

event_changed

Constructors

constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

count

count: number

Gets total count of background progresses

id

id: number

Gets integer id of the object

objectType

objectType: string

Gets the object type as string

onChanged

onChanged: JSCallbacks

Undocumented

persistentID

persistentID: string

Gets persistent id of the object

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Gets the object title

Methods

createNew

doCut

  • doCut(data): Promise<any>

  • Parameters

    Returns Promise<any>

    Undocumented

getClassName

  • getClassName(): string

  • Gets class name of the object.

    Returns string

getPersistentJSON

getValue

  • getValue(index): BackgroundTask

  • Gets background task in given index

    Parameters

    • index: number

      Index of the task in list

    Returns BackgroundTask

    BackgroundTask

getVisibleCount

  • getVisibleCount(): number

  • Gets count of tasks with visible progresses

    Returns number

    integer

isMarked

  • isMarked(id): boolean

  • Parameters

    • id: number

    Returns boolean

    Undocumented

locked

  • locked(func): void

  • Call defined method with locked data so user can access them.

    Parameters

    • func: (() => any)

      Method to call

        • (): any

        • Returns any

    Returns void

setMarked

  • setMarked(id, value): void

  • Parameters

    • id: number
    • value: boolean

    Returns void

    Undocumented

terminateAll

  • terminateAll(): void

  • Terminate all background tasks

    Returns void

Events

event_changed

event_changed: ((op, task) => void)

Change event is called every time something is changed in any background task.
Available operations:

  • 'unregistered' - task was removed
  • 'registered' - task is just started
  • 'enabled' - task is enabled
  • 'disabled' - task is disabled
  • 'textchanged' - text of the progress was changed
  • 'progresschanged' - percent of progress was changed
  • 'descriptionchanged' - description of the progress was changed

See App.listen

Type declaration

    • (op, task): void

    • Parameters

      • op: string

        Operation performed to task.

      • task: BackgroundTask

        task related do operation. When operation is 'unregistered', ID is returned instead of task

      Returns void

Download
Forum
Support
Addons
Develop

Settings

Member Visibility

Theme

© 2000-2024 Ventis Media Inc.Generated using TypeDoc