Home > @tridion-sites/open-api-client > TranslationService
Signature:
export declare class TranslationService
Method | Modifiers | Description |
---|---|---|
copyTranslationJob({ jobId, save, }) | static |
Copies the translation job that has the specified job ID. This operation returns an instance of ‘TranslationJob’ type. |
createTranslationJob({ translationJob, autoSend, }) | static |
Creates a new translation job. This operation returns an instance of ‘TranslationJob’ type. |
deleteTranslationJob({ jobId, }) | static |
Deletes the translation job that has the specified job ID. |
fetchTranslationInfo({ escapedItemId, }) | static |
<p>Gets the translation information for a specified item. This operation returns an instance of ‘TranslationInfo’ type.</p><p>This route is used as the HATEOAS URL for the tm:TranslationInfo ListLink.</p> |
fetchTranslationJob({ jobId, }) | static |
Gets full details for the translation job with the specified job ID. This operation returns an instance of ‘TranslationJob’ type. |
fetchTranslationJobDefaultData({ itemIds, jobType, }) | static |
Gets a translation job model with default data, which you can use as the basis for creating a translation job. This operation returns an instance of ‘TranslationJob’ type. |
listTranslationJobs() | static |
Gets an overview of all translation jobs. This operation returns an instance of ‘TranslationJobOverview’ type or one of the following inherited types:<ul class="model-list"><li>TranslationJob</li></ul> |
pullTranslation({ escapedItemId, }) | static |
<p>Pulls a translation for a specified item by creating a pull translation job containing the item and sending it to translation. This operation returns an instance of ‘TranslationJob’ type.</p><p>This route is used as HATEOAS URL for the tm:PullTranslation Applicable Action</p> |
pushTranslation({ escapedItemId, }) | static |
<p>Pushes the specified item into translation by creating a push translation job containing the item and sending it to translation. This operation returns an instance of ‘TranslationJob’ type.</p><p>This route is used as HATEOAS URL for the tm:PushTranslation Applicable Action</p> |
retryTranslationJob({ jobId, }) | static |
Retries to send or retrieve a translation job. This operation returns an instance of ‘TranslationJob’ type. |
sendTranslationJob({ jobId, }) | static |
Sends a job for translation. This operation returns an instance of ‘TranslationJob’ type. |
updateTranslationJob({ jobId, translationJob, }) | static |
Updates an existing translation job with new data. This operation returns an instance of ‘TranslationJob’ type. |