Class SourceStrings

Source strings are the text units for translation. Instead of modifying source files, you can manage source strings one by one.

Use API to add, edit, or delete some specific strings in the source-based and files-based projects.

Hierarchy (view full)

CrowdinApi
- SourceStrings

Index

Constructors

constructor

Methods

addString deleteString editString getString graphql listProjectStrings stringBatchOperations uploadStrings uploadStringsStatus withFetchAll

Constructors

constructor

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

Methods

addString

addString(projectId, request): Promise<ResponseObject<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- request: CreateStringRequest | CreateStringStringsBasedRequest
  request body
Returns Promise<ResponseObject<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.post
- Defined in sourceStrings/index.ts:126

deleteString

deleteString(projectId, stringId): Promise<void>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.delete
- Defined in sourceStrings/index.ts:168

editString

editString(projectId, stringId, request): Promise<ResponseObject<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.patch
- Defined in sourceStrings/index.ts:179

getString

getString(projectId, stringId, query?): Promise<ResponseObject<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
- Optionalquery: {
  denormalizePlaceholders: BooleanInt;
  }
  query params
  - denormalizePlaceholders: BooleanInt
Returns Promise<ResponseObject<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.get
- Defined in sourceStrings/index.ts:153

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

listProjectStrings

listProjectStrings(projectId, options?): Promise<ResponseList<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListProjectStringsOptions
  optional parameters for the request
Returns Promise<ResponseList<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.getMany
- Defined in sourceStrings/index.ts:48
listProjectStrings(projectId, fileId?, limit?, offset?, filter?, denormalizePlaceholders?, labelIds?, scope?, croql?, branchId?, directoryId?): Promise<ResponseList<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- OptionalfileId: number
  file identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- Optionalfilter: string
  filter strings by text and context
- OptionaldenormalizePlaceholders: BooleanInt
  enable denormalize placeholders
- OptionallabelIds: string
  filter strings by labelIds
- Optionalscope: Scope
  specify field to be the target of filtering
- Optionalcroql: string
  filter strings by CroQL (Can't be used with labelIds, filter or scope in same request)
- OptionalbranchId: number
  filter by branch identifier
- OptionaldirectoryId: number
  filter by directory identifier
Returns Promise<ResponseList<SourceStringsModel.String>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.getMany
- Defined in sourceStrings/index.ts:67

stringBatchOperations

stringBatchOperations(projectId, request): Promise<ResponseList<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseList<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings.batchPatch
- Defined in sourceStrings/index.ts:139

uploadStrings

uploadStrings(projectId, request): Promise<ResponseObject<Status<UploadStringsStatus>>>
Parameters
- projectId: number
  project identifier
- request: UploadStringsRequest
  request payload
Returns Promise<ResponseObject<Status<UploadStringsStatus>>>
- Defined in sourceStrings/index.ts:35

uploadStringsStatus

uploadStringsStatus(projectId, uploadId): Promise<ResponseObject<Status<UploadStringsStatus>>>
Parameters
- projectId: number
  project identifier
- uploadId: string
  export identifier
Returns Promise<ResponseObject<Status<UploadStringsStatus>>>
- Defined in sourceStrings/index.ts:23

withFetchAll

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

Class SourceStrings

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SourceStrings

Methods

addString

Parameters

Returns Promise<ResponseObject<SourceStringsModel.String>>

See

deleteString

Parameters

Returns Promise<void>

See

editString

Parameters

Returns Promise<ResponseObject<SourceStringsModel.String>>

See

getString

Parameters

denormalizePlaceholders: BooleanInt

Returns Promise<ResponseObject<SourceStringsModel.String>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listProjectStrings

Parameters

Returns Promise<ResponseList<SourceStringsModel.String>>

See

Parameters

Returns Promise<ResponseList<SourceStringsModel.String>>

Deprecated

See

stringBatchOperations

Parameters

Returns Promise<ResponseList<SourceStringsModel.String>>

See

uploadStrings

Parameters

Returns Promise<ResponseObject<Status<UploadStringsStatus>>>

uploadStringsStatus

Parameters

Returns Promise<ResponseObject<Status<UploadStringsStatus>>>

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string