Search Results for

Show / Hide Table of Contents

# Interface ILiveDocsService

This interface has operations for listing managing corpora on the memoQ Server.

##### Syntax

    public interface ILiveDocsService

### Methods

#### AlignDocumentsGetTmx(DocumentForAlignment, DocumentForAlignment, AlignmentOptions)

Performs structural alignment of two documents and exports the aligned segment pairs as a TMX. First the documents are imported using the specified configurations, then the alignment is performed, and the resulting matched segment pairs are exported into a TMX (optionally zipped). The two files must be uploaded using IFileManagerServive before invoking this operation. If the result is success, the resulting file can also be downloaded using IFileManagerService.

##### Declaration

    AlignmentResultInfo AlignDocumentsGetTmx(DocumentForAlignment source, DocumentForAlignment target, AlignmentOptions options)

##### Parameters

Type | Name | Description
--- | --- | ---
DocumentForAlignment | source | The source document and its import configuration.
DocumentForAlignment | target | The target document and its import configuration.
AlignmentOptions | options | Options of the alignment operation.

##### Returns

Type | Description
--- | ---
AlignmentResultInfo | Object describing the result fo the process and a reference to the TMX file containing the aligned pairs.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### CreateAndPublish(CorpusInfo)

Creates a new corpus with the parameters specified by the info operation parameter.

##### Declaration

    Guid CreateAndPublish(CorpusInfo info)

##### Parameters

Type | Name | Description
--- | --- | ---
CorpusInfo | info | The parameters of the corpus to be created. The Guid and the Languages members of the info parameter are ignored.

##### Returns

Type | Description
--- | ---
System.Guid | The Guid of the newly created corpora.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### DeleteCorpus(Guid)

Deletes a corpus.

##### Declaration

    void DeleteCorpus(Guid corpusGuid)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Guid | corpusGuid | The guid of the corpus to be deleted.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### GetCorpusInfo(Guid)

Gets information about the specified corpus.

##### Declaration

    CorpusInfo GetCorpusInfo(Guid corpusGuid)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Guid | corpusGuid | The guid of the corpus.

##### Returns

Type | Description
--- | ---
CorpusInfo | The CorpusInfo object describing the corpus.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### ImportReferenceDocuments(Guid, ImportFileIntoLiveDocsOptions[])

Imports multiple reference documents into a LiveDocs corpus. The options of the import are configured for each file separately using the appropriate descendent of ImportFileIntoLiveDocsOptions, namely

- ImportBinaryFileIntoLiveDocsOptions,
- ImportMonoOrBilingualFileIntoLiveDocsOptions,
- ImportLiveDocsXliffFileIntoLiveDocsOptions.

##### Declaration

    ImportFileIntoLiveDocsResultInfo[] ImportReferenceDocuments(Guid corpusGuid, ImportFileIntoLiveDocsOptions[] importOptions)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Guid | corpusGuid | The ID of corpus to import into.
ImportFileIntoLiveDocsOptions[] | importOptions |

##### Returns

Type | Description
--- | ---
ImportFileIntoLiveDocsResultInfo[] | A result object for each imported file in the same order the import options are specified.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### ListCorpora(String[])

Returns the list of corpora published by the memoQ Server.

##### Declaration

    CorpusInfo[] ListCorpora(string[] languages)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String[] | languages | Can be used to filter the returned list of corpora based on the languages of the corpora. It is allowed to provide null.

##### Returns

Type | Description
--- | ---
CorpusInfo[] | An array of CorporaInfo objects each describing one corpora.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### ListCorpora2(CorpusListFilter)

Returns the list of corpora published by the memoQ Server mathing the specified filter.

##### Declaration

    CorpusInfo[] ListCorpora2(CorpusListFilter filter)

##### Parameters

Type | Name | Description
--- | --- | ---
CorpusListFilter | filter | Optional filter criteria.

##### Returns

Type | Description
--- | ---
CorpusInfo[] | An array of CorporaInfo objects each describing one corpora.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

#### UpdateProperties(CorpusUpdateInfo)

Updates the properties of a corpus. (Renaming a corpus is also possible by updating its name via this operation.)

##### Declaration

    void UpdateProperties(CorpusUpdateInfo updateInfo)

##### Parameters

Type | Name | Description
--- | --- | ---
CorpusUpdateInfo | updateInfo | The new properties of the corpus. The Guid member identifies the corpus to be updated.

##### Exceptions

Type | Condition
--- | ---
UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result.
GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.