Class TranslationMemory

Translation Memory (TM) is a vault of translations that were previously made in other projects. Those translations can be reused to speed up the translation process. Every translation made in the project is automatically added to the project Translation Memory.

Use API to create, upload, download, or remove specific TM. Translation Memory export and import are asynchronous operations and shall be completed with sequence of API methods.

Hierarchy (view full)

CrowdinApi
- TranslationMemory

Constructors

constructor

new TranslationMemory(credentials, config?): TranslationMemory
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns TranslationMemory
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:232

Methods

addTm

addTm(request): Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>
Parameters
- request: AddTranslationMemoryRequest
  request body
Returns Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.post
- Defined in translationMemory/index.ts:59

addTmSegment

addTmSegment(tmId, request): Promise<ResponseObject<TMSegment>>
Parameters
- tmId: number
  tm identifier
- request: AddTMSegment
  request body
Returns Promise<ResponseObject<TMSegment>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.post
- Defined in translationMemory/index.ts:114

addTmSegmentRecords

addTmSegmentRecords(tmId, segmentId, request): Promise<ResponseObject<TMSegment>>
Parameters
- tmId: number
  tm identifier
- segmentId: number
  segment identifier
- request: AddTMSegment
  request body
Returns Promise<ResponseObject<TMSegment>>
Deprecated
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.records.post
- Defined in translationMemory/index.ts:278

checkExportStatus

checkExportStatus(tmId, exportId): Promise<ResponseObject<Status<ExportTranslationMemoryAttribute>>>
Parameters
- tmId: number
  tm identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<Status<ExportTranslationMemoryAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.exports.get
- Defined in translationMemory/index.ts:149

checkImportStatus

checkImportStatus(tmId, importId): Promise<ResponseObject<Status<ImportTranslationMemoryAttribute>>>
Parameters
- tmId: number
  tm identifier
- importId: string
  import identifier
Returns Promise<ResponseObject<Status<ImportTranslationMemoryAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.imports.get
- Defined in translationMemory/index.ts:198

clearTm

clearTm(tmId): Promise<void>
Parameters
- tmId: number
  tm identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.clear
- Defined in translationMemory/index.ts:126

concordanceSearch

concordanceSearch(projectId, request): Promise<ResponseList<TranslationMemoryModel.ConcordanceSearchResponse>>
Parameters
- projectId: number
  project identifier
- request: TranslationMemoryModel.ConcordanceSearchRequest
  request body
Returns Promise<ResponseList<TranslationMemoryModel.ConcordanceSearchResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.tms.concordance.post
- Defined in translationMemory/index.ts:172

deleteTm

deleteTm(tmId): Promise<void>
Parameters
- tmId: number
  tm identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.delete
- Defined in translationMemory/index.ts:79

deleteTmSegment

deleteTmSegment(tmId, segmentId): Promise<void>
Parameters
- tmId: number
  tm identifier
- segmentId: number
  segment identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.delete
- Defined in translationMemory/index.ts:221

deleteTmSegmentRecord

deleteTmSegmentRecord(tmId, segmentId, recordId): Promise<void>
Parameters
- tmId: number
  tm identifier
- segmentId: number
  segment identifier
- recordId: number
  record identifier
Returns Promise<void>
Deprecated
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.records.delete
- Defined in translationMemory/index.ts:248

downloadTm

downloadTm(tmId, exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- tmId: number
  tm identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.exports.download.download
- Defined in translationMemory/index.ts:162

editTm

editTm(tmId, request): Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>
Parameters
- tmId: number
  tm identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.patch
- Defined in translationMemory/index.ts:89

editTmSegment

editTmSegment(tmId, segmentId, request): Promise<ResponseObject<TMSegment>>
Parameters
- tmId: number
  tm identifier
- segmentId: number
  segment identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<TMSegment>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.patch
- Defined in translationMemory/index.ts:232

editTmSegmentRecord

editTmSegmentRecord(tmId, segmentId, recordId, request): Promise<ResponseObject<TMSegment>>
Parameters
- tmId: number
  tm identifier
- segmentId: number
  segment identifier
- recordId: number
  record identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<TMSegment>>
Deprecated
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.records.patch
- Defined in translationMemory/index.ts:261

exportTm

exportTm(tmId, request?): Promise<ResponseObject<Status<ExportTranslationMemoryAttribute>>>
Parameters
- tmId: number
  tm identifier
- request: ExportTranslationMemoryRequest = {}
  request body
Returns Promise<ResponseObject<Status<ExportTranslationMemoryAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.exports.post
- Defined in translationMemory/index.ts:136

getTm

getTm(tmId): Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>
Parameters
- tmId: number
  tm identifier
Returns Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.get
- Defined in translationMemory/index.ts:70

getTmSegment

getTmSegment(tmId, segmentId): Promise<ResponseObject<TMSegment>>
Parameters
- tmId: number
  tm identifier
- segmentId: number
  segment identifier
Returns Promise<ResponseObject<TMSegment>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.get
- Defined in translationMemory/index.ts:211

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:266

importTm

importTm(tmId, request): Promise<ResponseObject<Status<ImportTranslationMemoryAttribute>>>
Parameters
- tmId: number
  tm identifier
- request: ImportTranslationMemoryRequest
  request body
Returns Promise<ResponseObject<Status<ImportTranslationMemoryAttribute>>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.imports.post
- Defined in translationMemory/index.ts:185

listTm

listTm(options?): Promise<ResponseList<TranslationMemoryModel.TranslationMemory>>
Parameters
- Optionaloptions: ListTMsOptions
  optional paramerers for the request
Returns Promise<ResponseList<TranslationMemoryModel.TranslationMemory>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.getMany
- Defined in translationMemory/index.ts:25
listTm(groupId?, limit?, offset?): Promise<ResponseList<TranslationMemoryModel.TranslationMemory>>
Parameters
- OptionalgroupId: number
  group identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<TranslationMemoryModel.TranslationMemory>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.tms.getMany
- Defined in translationMemory/index.ts:35

listTmSegments

listTmSegments(tmId, options?): Promise<ResponseList<TMSegment>>
Parameters
- tmId: number
  tm identifier
- Optionaloptions: ListSegmentsOptions
  optional paramerers for the request
Returns Promise<ResponseList<TMSegment>>
See
https://developer.crowdin.com/api/v2/#operation/api.tms.segments.getMany
- Defined in translationMemory/index.ts:99

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:328

Class TranslationMemory

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TranslationMemory

Methods

addTm

Parameters

Returns Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>

See

addTmSegment

Parameters

Returns Promise<ResponseObject<TMSegment>>

See

addTmSegmentRecords

Parameters

Returns Promise<ResponseObject<TMSegment>>

Deprecated

See

checkExportStatus

Parameters

Returns Promise<ResponseObject<Status<ExportTranslationMemoryAttribute>>>

See

checkImportStatus

Parameters

Returns Promise<ResponseObject<Status<ImportTranslationMemoryAttribute>>>

See

clearTm

Parameters

Returns Promise<void>

See

concordanceSearch

Parameters

Returns Promise<ResponseList<TranslationMemoryModel.ConcordanceSearchResponse>>

See

deleteTm

Parameters

Returns Promise<void>

See

deleteTmSegment

Parameters

Returns Promise<void>

See

deleteTmSegmentRecord

Parameters

Returns Promise<void>

Deprecated

See

downloadTm

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editTm

Parameters

Returns Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>

See

editTmSegment

Parameters

Returns Promise<ResponseObject<TMSegment>>

See

editTmSegmentRecord

Parameters

Returns Promise<ResponseObject<TMSegment>>

Deprecated

See

exportTm

Parameters

Returns Promise<ResponseObject<Status<ExportTranslationMemoryAttribute>>>

See

getTm

Parameters

Returns Promise<ResponseObject<TranslationMemoryModel.TranslationMemory>>

See

getTmSegment

Parameters

Returns Promise<ResponseObject<TMSegment>>

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string