public interface AsynchronousProcessResource
Modifier and Type | Method and Description |
---|---|
ProcessStatus |
getProcessStatus(String processId)
Obtains the status of a previously started process.
|
ProcessStatus |
startSourceDocCreation(String idNoSlash,
String projectSlug,
String iterationSlug,
Resource resource,
Set<String> extensions,
boolean copytrans)
Attempts to start the creation of a source document.
|
ProcessStatus |
startSourceDocCreationOrUpdate(String idNoSlash,
String projectSlug,
String iterationSlug,
Resource resource,
Set<String> extensions,
boolean copytrans)
Attempts to starts the creation or update of a source document.
|
ProcessStatus |
startTranslatedDocCreationOrUpdate(String idNoSlash,
String projectSlug,
String iterationSlug,
LocaleId locale,
TranslationsResource translatedDoc,
Set<String> extensions,
String merge)
Attempts to starts the translation of a document.
|
ProcessStatus startSourceDocCreation(String idNoSlash, String projectSlug, String iterationSlug, Resource resource, Set<String> extensions, boolean copytrans)
idNoSlash
- The document identifier. Some document ids could have forward slashes ('/') in them which would
cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/'
characters replaced with commas (',').projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.resource
- The document information.extensions
- The document extensions to save with the document (e.g. "gettext", "comment"). This parameter
allows multiple values e.g. "ext=gettext&ext=comment".copytrans
- Boolean value that indicates whether reasonably close translations from other projects should be
found to initially populate this document's translations.ProcessStatus startSourceDocCreationOrUpdate(String idNoSlash, String projectSlug, String iterationSlug, Resource resource, Set<String> extensions, boolean copytrans)
idNoSlash
- The document identifier. Some document ids could have forward slashes ('/') in them which would
cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/'
characters replaced with commas (',').projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.resource
- The document information.extensions
- The document extensions to save with the document (e.g. "gettext", "comment"). This parameter
allows multiple values e.g. "ext=gettext&ext=comment".copytrans
- Boolean value that indicates whether reasonably close translations from other projects should be
found to initially populate this document's translations.ProcessStatus startTranslatedDocCreationOrUpdate(String idNoSlash, String projectSlug, String iterationSlug, LocaleId locale, TranslationsResource translatedDoc, Set<String> extensions, String merge)
idNoSlash
- The document identifier. Some document ids could have forward slashes ('/') in them which would
cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/'
characters replaced with commas (',').projectSlug
- Project identifier.iterationSlug
- Project Iteration identifier.locale
- The locale for which to get translations.translatedDoc
- The translations to modify.extensions
- The document extensions to save with the document (e.g. "gettext", "comment"). This parameter
allows multiple values e.g. "ext=gettext&ext=comment".merge
- Indicates how to deal with existing translations (valid options: 'auto', 'import'). Import will
overwrite all current values with the values being pushed (even empty ones), while Auto will check the history
of your translations and will not overwrite any translations for which it detects a previous value is being pushed.ProcessStatus getProcessStatus(String processId)
processId
- The process Id (as returned by one of the endpoints that starts an async process).Copyright © 2013 Zanata Project. All Rights Reserved.