Class Translations

Translators can work with entirely untranslated project or you can pre-translate the files to ease the translations process.

Use API to pre-translate files via Machine Translation (MT) or Translation Memory (TM), upload your existing translations, and download translations correspondingly. Pre-translate and build are asynchronous operations and shall be completed with sequence of API methods.

Hierarchy (view full)

CrowdinApi
- Translations

Index

Constructors

constructor

Methods

applyPreTranslation buildProject buildProjectDirectoryTranslation buildProjectFileTranslation cancelBuild checkBuildStatus downloadTranslations editPreTranslation exportProjectTranslation graphql listPreTranslations listProjectBuilds preTranslationStatus uploadTranslation uploadTranslationStrings withFetchAll

Constructors

constructor

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

Methods

buildProjectFileTranslation

buildProjectFileTranslation(projectId, fileId, request, eTag?): Promise<ResponseObject<BuildProjectFileTranslationResponse>>
Parameters
- projectId: number
  project identifier
- fileId: number
  file identifier
- request: BuildProjectFileTranslationRequest
  request body
- OptionaleTag: string
  'If-None-Match' header
Returns Promise<ResponseObject<BuildProjectFileTranslationResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.files.post
- Defined in translations/index.ts:96

cancelBuild

cancelBuild(projectId, buildId): Promise<void>
Parameters
- projectId: number
  project identifier
- buildId: number
  build identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.delete
- Defined in translations/index.ts:209

checkBuildStatus

checkBuildStatus(projectId, buildId): Promise<ResponseObject<Build>>
Parameters
- projectId: number
  project identifier
- buildId: number
  build identifier
Returns Promise<ResponseObject<Build>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.get
- Defined in translations/index.ts:199

downloadTranslations

downloadTranslations(projectId, buildId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- buildId: number
  build identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.download.download
- Defined in translations/index.ts:189

editPreTranslation

editPreTranslation(projectId, preTranslationId, request): Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>
Parameters
- projectId: number
  project identifier
- preTranslationId: string
  pre translation identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.pre-translations.patch
- Defined in translations/index.ts:64

exportProjectTranslation

exportProjectTranslation(projectId, request): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- request: ExportProjectTranslationRequest
  request body
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.exports.post
- Defined in translations/index.ts:219

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:264

listPreTranslations

listPreTranslations(projectId, options?): Promise<ResponseList<Status<PreTranslationStatusAttributes>>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<Status<PreTranslationStatusAttributes>>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.pre-translations.getMany
- Defined in translations/index.ts:24

listProjectBuilds

listProjectBuilds(projectId, options?): Promise<ResponseList<Build>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListProjectBuildsOptions
  optional parameters for the request
Returns Promise<ResponseList<Build>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.getMany
- Defined in translations/index.ts:115
listProjectBuilds(projectId, branchId?, limit?, offset?): Promise<ResponseList<Build>>
Parameters
- projectId: number
  project identifier
- OptionalbranchId: number
  branch identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Build>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.builds.getMany
- Defined in translations/index.ts:127

preTranslationStatus

preTranslationStatus(projectId, preTranslationId): Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>
Parameters
- projectId: number
  project identifier
- preTranslationId: string
  pre translation identifier
Returns Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>
See
https://developer.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get
- Defined in translations/index.ts:37

uploadTranslation

uploadTranslation(projectId, languageId, request): Promise<ResponseObject<UploadTranslationResponse>>
Parameters
- projectId: number
  project identifier
- languageId: string
  language identifier
- request: UploadTranslationRequest
  request body
Returns Promise<ResponseObject<UploadTranslationResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.postOnLanguage
- Defined in translations/index.ts:166

uploadTranslationStrings

uploadTranslationStrings(projectId, languageId, request): Promise<ResponseObject<UploadTranslationStringsResponse>>
Parameters
- projectId: number
- languageId: string
- request: UploadTranslationStringsRequest
Returns Promise<ResponseObject<UploadTranslationStringsResponse>>
- Defined in translations/index.ts:175

withFetchAll

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

Class Translations

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Translations

Methods

applyPreTranslation

Parameters

Returns Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>

See

buildProject

Parameters

Returns Promise<ResponseObject<Build>>

See

buildProjectDirectoryTranslation

Parameters

Returns Promise<ResponseObject<BuildProjectDirectoryTranslationResponse>>

See

buildProjectFileTranslation

Parameters

Returns Promise<ResponseObject<BuildProjectFileTranslationResponse>>

See

cancelBuild

Parameters

Returns Promise<void>

See

checkBuildStatus

Parameters

Returns Promise<ResponseObject<Build>>

See

downloadTranslations

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editPreTranslation

Parameters

Returns Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>

See

exportProjectTranslation

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listPreTranslations

Parameters

Returns Promise<ResponseList<Status<PreTranslationStatusAttributes>>>

See

listProjectBuilds

Parameters

Returns Promise<ResponseList<Build>>

See

Parameters

Returns Promise<ResponseList<Build>>

Deprecated

See

preTranslationStatus

Parameters

Returns Promise<ResponseObject<Status<PreTranslationStatusAttributes>>>

See

uploadTranslation

Parameters

Returns Promise<ResponseObject<UploadTranslationResponse>>

See

uploadTranslationStrings

Parameters

Returns Promise<ResponseObject<UploadTranslationStringsResponse>>

withFetchAll

Parameters

Returns this

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string