tridion-sites-extensions-api-docs

Home > @tridion-sites/models > RetrieveReason

RetrieveReason type

Used in TranslationJobInfo to indicate why the item was retrieved.

* unknown - The reason is not known. Most likely the item was retrieved by a previous version of Translation Manager that could only retrieve items when they were Completed. * completed - The item was completed in the Translation Management system. Translation Manager consider the Item completed and will complete the Translation Job once all items are in this stage. * review -The item was retrieved to allow review in Tridion Sites. The item remains in control of the translation management system’s workflow and Translation Manager will attempt to retrieve the Item again. * preview - The item was retrieved to allow preview in Tridion Sites. The item remains in control of the translation management system’s workflow and Translation Manager will attempt to retrieve the Item again. * unknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.

Signature:

export type RetrieveReason = 'unknown' | 'completed' | 'review' | 'preview' | 'unknownByClient';