Class Job

Provides properties and methods for obtaining information about a job on the Open Cloud Server.

Hierarchy (View Summary)

Constructors

constructor

Properties

headers path

Accessors

assemblyId authorId createdAt data done fileId id lastUpdate outputFormat parameters startedAt status statusMessage

Methods

checkout delete update waitForDone

Constructors

constructor

  • new Job(data: any, httpClient: IHttpClient): Job

  • Parameters

    • data: any

      Raw job data received from the server. For more information, see Open Cloud Jobs API.

    • httpClient: IHttpClient

      HTTP client instance used to send requests to the REST API server.

    Returns Job

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

assemblyId

  • get assemblyId(): string

  • The ID of the assembly the job is working on (internal).

    Returns string

authorId

  • get authorId(): string

  • Job creator ID. Use Client.getUser() to obtain detailed creator information.

    Returns string

createdAt

  • get createdAt(): string

  • Job creation time (UTC) in the format specified in ISO 8601.

    Returns string

data

  • get data(): any

  • Raw job data received from the server. For more information, see Open Cloud Jobs API.

    Returns any

done

  • get done(): boolean

  • true if job is done or failed. See status for more details.

    Returns boolean

fileId

  • get fileId(): string

  • The ID of the file the job is working on.

    Returns string

id

  • get id(): string

  • Unique job ID.

    Returns string

lastUpdate

  • get lastUpdate(): string

  • Job last update (UTC) time in the format specified in ISO 8601.

    Returns string

outputFormat

  • get outputFormat(): string

  • Job type. Can be properties, geomerty, geomertyGltf, validation, clash, dwg, obj, gltf, glb, vsf, pdf, 3dpdf or custom job name.

    Returns string

parameters

  • get parameters(): any

  • Parameters with which the job runner was started. For more information, see Open Cloud Jobs API.

    Returns any

startedAt

  • get startedAt(): string

  • Job starting time (UTC) in the format specified in ISO 8601.

    Returns string

status

  • get status(): string

  • Job status. Can be waiting, inprogress, done or failed.

    Returns string

statusMessage

  • get statusMessage(): string

  • Job status description message.

    Returns string

Methods

checkout

  • checkout(): Promise<Job>

  • Reloads job data from the server.

    Returns Promise<Job>

delete

  • delete(): Promise<any>

  • Deletes a job from the server job list. Jobs that are in progress or have already been completed cannot be deleted.

    Returns Promise<any>

    Returns the raw data of a deleted job. For more information, see Open Cloud Jobs API.

update

  • update(data: any): Promise<Job>

  • Updates job data on the server.

    Only administrators can update job data. If the current logged in user is not an administrator, an exception will be thrown.

    Parameters

    Returns Promise<Job>

waitForDone

  • waitForDone(
        params?: {
            interval?: number;
            onCheckout?: (job: Job, ready: boolean) => boolean;
            signal?: AbortSignal;
            timeout?: number;
        },
    ): Promise<Job>

  • Waits for job to be done. Job is done when it changes to done or failed status.

    Parameters

    • Optionalparams: {
          interval?: number;
          onCheckout?: (job: Job, ready: boolean) => boolean;
          signal?: AbortSignal;
          timeout?: number;
      }

      An object containing waiting parameters.

      • Optionalinterval?: number

        The time, in milliseconds, the function should delay in between checking job status.

      • OptionalonCheckout?: (job: Job, ready: boolean) => boolean

        Waiting progress callback. Return true to cancel waiting.

      • Optionalsignal?: AbortSignal

        An AbortController signal, which can be used to abort waiting as desired.

      • Optionaltimeout?: number

        The time, in milliseconds that the function should wait job. If jobs is not done during this time, the TimeoutError exception will be thrown.

    Returns Promise<Job>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods