JobRevision
Extends:
Static Member Summary
Static Public Members | ||
public static get |
|
|
public static get |
|
|
public static get |
|
Member Summary
Public Members | ||
public get |
|
|
public get |
Get layers |
|
public get |
resultProxy: JobResult: * Get a result proxy |
Method Summary
Public Methods | ||
public |
build(callback: String, deleted: String): CancelablePromise Build the revision |
|
public |
cancel(deleted: String): CancelablePromise Cancels a running job |
|
public |
clone(title: String, deleted: String): CancelablePromise<JobRevision> Clones a job revision to the user requesting it |
|
public |
object(deleted: String): CancelablePromise<Object> Get job object |
|
public |
result(deleted: String): CancelablePromise<JobResult> Get the job result |
|
public |
save(object: Object, layers: null, deleted: String): CancelablePromise<JobRevision> Save updated job revision |
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 |
protectedFields: Array<string>: string[] Protected read-only fields |
|
public get |
api: Mapcreator: * Get api instance |
|
public set |
api(value: Mapcreator) Set the api instance |
|
public get |
Auto generated Resource base url |
|
public get |
fieldNames: Array<String>: * List fields that contain object data |
|
public get |
If the resource can be owned by an organisation |
|
public get |
Auto generated resource url |
|
public |
Clone the object |
|
public |
refresh(updateSelf: Boolean): CancelablePromise<ResourceBase> Refresh the resource by requesting it from the server again |
|
public |
Resets model instance to it's original state |
|
public |
sanitize() Clean up instance and commit all changes locally. |
|
public |
static(Target: string | Class, Constructor: Class?, seedData: Object<string, *>): SimpleResourceProxy Static proxy generation |
|
public |
Transform instance to object |
|
public |
String representation of the resource, similar to Python's repr |
|
protected |
_guessType(name: string, value: *): * Guess type based on property name |
|
protected |
_proxyResourceList(Target: string | Class<ResourceBase>, url: String, seedData: object): SimpleResourceProxy Macro for resource listing |
|
protected |
Moves new fields to this._properties and turns them into a getter/setter |
From class CrudBase | ||
public |
delete(updateSelf: Boolean): CancelablePromise<CrudBase> Delete item |
|
public |
restore(updateSelf: Boolean): CancelablePromise<CrudBase> Restore item |
|
public |
Save item. |
|
protected |
_buildCreateData(): Object<String, *> Build data for create operation |
|
protected |
Update existing item |
Static Public Members
public static get resourcePath: string source
Resource path template
Override:
ResourceBase#resourcePathpublic static get resourceUrlKey: string source
Returns the url key of the resource
Override:
ResourceBase#resourceUrlKeyPublic Members
Public Methods
public build(callback: String, deleted: String): CancelablePromise source
Build the revision
Throw:
If the api returns errors |
public cancel(deleted: String): CancelablePromise source
Cancels a running job
Params:
Name | Type | Attribute | Description |
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |
public clone(title: String, deleted: String): CancelablePromise<JobRevision> source
Clones a job revision to the user requesting it
Override:
ResourceBase#cloneThrow:
If the api returns errors |
public object(deleted: String): CancelablePromise<Object> source
Get job object
Params:
Name | Type | Attribute | Description |
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |
public result(deleted: String): CancelablePromise<JobResult> source
Get the job result
Params:
Name | Type | Attribute | Description |
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |
Throw:
If the api returns errors |
public save(object: Object, layers: null, deleted: String): CancelablePromise<JobRevision> source
Save updated job revision
Override:
CrudBase#saveParams:
Name | Type | Attribute | Description |
object | Object | Map object |
|
layers | null | Array containing all layers for this revision. If set to null the same layers will be used |
|
deleted | String |
|
Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all |