tridion-sites-extensions-api-docs

Home > @tridion-sites/models > IdentifiableTranslationJob

IdentifiableTranslationJob class

TranslationJob class that extends IdentifiableObject, that uses ItemUri instead of number as an id.

Please note that the rest of IdentifiableObject props will be undefined always.

To get original object use getOriginalInternalModel(), as getInternalModel() result will include Id in a format tm:0-1234.

Signature:

export declare class IdentifiableTranslationJob extends IdentifiableObject

Extends: IdentifiableObject

Example

TranslationJob.id: number | undefined; IdentifiableTranslationJob.id: ItemUri;

Constructors

Constructor Modifiers Description
(constructor)({ addedItems, backendModel, configurationItemUri, creationDate, creator, displayState, errors, errorSeverityLevel, language, priority, requiredDate, revisionDate, revisor, state, targetLanguages, type, workflowStatus, contextRepository, …identifiableObjectArgs })   Constructs a new instance of the IdentifiableTranslationJob class

Properties

Property Modifiers Type Description
_backendModel   BackendIdentifiableTranslationJob  
addedItems   ReadonlyArray<TranslationJobItem> | undefined Collection containing the AddedItems that have been added to this Translation Job. The AddedItems represent either an Item that will be translated (for example a Component) or an Item that contains the Items that will be translated (for example a Folder).
configurationItemUri   ItemUri | undefined TCM URI of the item containing the TranslationConfiguration used for this Translation Job.
contextRepository   Link | undefined Link to the Context Repository.
creationDate   Date | undefined The date the Translation Job was created (in UTC).
creator   Link | undefined A link to the user who created the Translation Job.
displayState   TranslationJobDisplayState | undefined  
errors   ReadonlyArray<TranslationErrorDetails> | undefined Collection of errors registered to this job.
errorSeverityLevel   TranslationErrorSeverity | undefined  
getInternalModel   () => BackendIdentifiableTranslationJob  
getOriginalInternalModel   () => BackendTranslationJob  
hasError   boolean  
includeItemsAlreadyTranslated   boolean Value indicating whether items that have already been translated should be included in the job.
isAwaitingAuthorization   boolean Value indicating if the Translation Job currently have one or more TranslationJobQuotes awaiting authorization (see remarks).
language   TmsLanguage | undefined  
metadata   FieldsValueDictionary | undefined Metadata associated with the Translation Job.
metadataSchemaUri   string | undefined TCM URI of the metadata schema used for this Translation Job.
priority   TranslationJobPriority | undefined The priority of the Translation Job. This value will only have an affect if SupportsPriority returns true.
progressPercentage   number | undefined  
requiredDate   Date | undefined The due date for this job.
revisionDate   Date | undefined  
revisor   Link | undefined A link to the user who last modified the Translation Job.
state   TranslationJobState | undefined  
supportsPriority   boolean Show if TranslationJob support setting of priority.
supportsRequiredDate   boolean Show if TranslationJob support setting required rate.
targetLanguages   ReadonlyArray<TargetLanguage> | undefined List of target languages available for this TranslationJob.
title   string | undefined  
type   ReadonlyArray<TranslationJobType> | undefined Value indicating if the Translation Job is a translation to the Publication of the ConfigurationItemUri (Pull job) or from the Publication (Push job).
workflowStatus   ReadonlyArray<TranslationWorkflowStatus> | undefined Item count of language/workflowstep pairs.