Home Manual Reference Source
public class | source

Job

Extends:

ResourceBaseCrudBase → Job

Static Member Summary

Static Public Members
public static get abstract

Resource name

Member Summary

Public Members
public get

Get the most up to date archive url

public get
this get was deprecated.

Get the most up to date preview url

public get

Get the most up to date preview url

public get

Get the list of associated job results

public get

Get the list job revisions

Method Summary

Public Methods
public

Get archive blob url

public

Download the job preview

public

async getOutputUrl(deleted: String): Promise<string>

Get the remote output url

Inherited Summary

From class ResourceBase
public static get

Returns if the resource is readonly

public static get abstract

Resource name

public static get

Resource path template

public static get

Returns the url key of the resource

protected static get

Protected read-only fields

public get

Get api instance

public set

api(value: Maps4News)

Set the api instance

public get

Auto generated Resource base url

public get

List fields that contain object data

public get

If the resource can be owned by an organisation

public get

url: string: *

Auto generated resource url

public

Clone the object

public

async refresh(updateSelf: Boolean): Promise<ResourceBase>

Refresh the resource by requesting it from the server again

public

reset(fields: Array<string> | string | null)

Resets model instance to it's original state

public

Clean up instance and commit all changes locally.

public

static(Target: string | function, Constructor: function, seedData: Object<string, *>): SimpleResourceProxy

Static proxy generation

public

toObject(camelCaseKeys: boolean): {}

Transform instance to object

public

String representation of the resource, similar to Python's repr

protected

Macro for resource listing

protected

Moves new fields to this._properties and turns them into a getter/setter

From class CrudBase
public

async delete(updateSelf: Boolean): Promise<CrudBase>

Delete item

public

async restore(updateSelf: Boolean): Promise<CrudBase>

Restore item

public

Save item.

protected

Build data for create operation

Static Public Members

public static get abstract resourceName: String: string source

Resource name

Override:

ResourceBase#resourceName

Return:

String

Resource name

Public Members

public get lastArchiveUrl: string: string source

Get the most up to date archive url

Return:

string

Last archive url

public get lastPreviewUrl: string: string source

this get was deprecated.

Get the most up to date preview url

Return:

string

Last preview url

Throw:

previewUrl

public get previewUrl: string: string source

Get the most up to date preview url

Return:

string

Preview url

public get results: SimpleResourceProxy: * source

Get the list of associated job results

Return:

SimpleResourceProxy

A proxy for accessing the resource

public get revisions: ResourceProxy: * source

Get the list job revisions

Return:

ResourceProxy

A proxy for accessing the resource

Public Methods

public async downloadOutput(deleted: String): Promise<DownloadedResource> source

Get archive blob url

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<DownloadedResource>

Job result output

public async downloadPreview(deleted: String): Promise<DownloadedResource> source

Download the job preview

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<DownloadedResource>

Job result preview

public async getOutputUrl(deleted: String): Promise<string> source

Get the remote output url

Params:

NameTypeAttributeDescription
deleted String
  • optional
  • default: RequestParameters.deleted

Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Return:

Promise<string>

The url to the output

Throw:

ApiError