Class Placeholders

Placeholders are constructs in source strings (variables, tags, format specifiers) that must be kept intact in translations.

Use the API to manage organization custom placeholders, assign them to projects, and turn system placeholders on or off per project.

Hierarchy (view full)

CrowdinApi
- Placeholders

Index

Constructors

constructor

Methods

addCustomPlaceholder addProjectPlaceholder deleteCustomPlaceholder deleteProjectPlaceholder editCustomPlaceholder editProjectPlaceholder getCustomPlaceholder getProjectPlaceholder graphql listCustomPlaceholders listProjectPlaceholders listSystemPlaceholders systemPlaceholdersBatchOperations withFetchAll

Constructors

constructor

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

Methods

addCustomPlaceholder

addCustomPlaceholder(request): Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>
Parameters
- request: PlaceholdersModel.AddCustomPlaceholderRequest
  request body
Returns Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.custom-placeholders.post
- Defined in placeholders/index.ts:22

addProjectPlaceholder

addProjectPlaceholder(projectId, request): Promise<ResponseObject<ProjectPlaceholder>>
Parameters
- projectId: number
  project identifier
- request: AddProjectPlaceholderRequest
  request body
Returns Promise<ResponseObject<ProjectPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.projects.placeholders.post
- Defined in placeholders/index.ts:78

deleteCustomPlaceholder

deleteCustomPlaceholder(customPlaceholderId): Promise<void>
Parameters
- customPlaceholderId: number
  custom placeholder identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.custom-placeholders.delete
- Defined in placeholders/index.ts:42

deleteProjectPlaceholder

deleteProjectPlaceholder(projectId, projectPlaceholderId): Promise<void>
Parameters
- projectId: number
  project identifier
- projectPlaceholderId: number
  project placeholder identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.projects.placeholders.delete
- Defined in placeholders/index.ts:104

editCustomPlaceholder

editCustomPlaceholder(customPlaceholderId, request): Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>
Parameters
- customPlaceholderId: number
  custom placeholder identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.custom-placeholders.patch
- Defined in placeholders/index.ts:52

editProjectPlaceholder

editProjectPlaceholder(projectId, projectPlaceholderId, request): Promise<ResponseObject<ProjectPlaceholder>>
Parameters
- projectId: number
  project identifier
- projectPlaceholderId: number
  project placeholder identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<ProjectPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.projects.placeholders.patch
- Defined in placeholders/index.ts:115

getCustomPlaceholder

getCustomPlaceholder(customPlaceholderId): Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>
Parameters
- customPlaceholderId: number
  custom placeholder identifier
Returns Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.custom-placeholders.get
- Defined in placeholders/index.ts:33

getProjectPlaceholder

getProjectPlaceholder(projectId, projectPlaceholderId): Promise<ResponseObject<ProjectPlaceholder>>
Parameters
- projectId: number
  project identifier
- projectPlaceholderId: number
  project placeholder identifier
Returns Promise<ResponseObject<ProjectPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.projects.placeholders.get
- Defined in placeholders/index.ts:91

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

listCustomPlaceholders

listCustomPlaceholders(options?): Promise<ResponseList<PlaceholdersModel.CustomPlaceholder>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<PlaceholdersModel.CustomPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.custom-placeholders.getMany
- Defined in placeholders/index.ts:13

listProjectPlaceholders

listProjectPlaceholders(projectId, options?): Promise<ResponseList<ProjectPlaceholder>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<ProjectPlaceholder>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Placeholders/operation/api.projects.placeholders.getMany
- Defined in placeholders/index.ts:65

listSystemPlaceholders

listSystemPlaceholders(projectId, options?): Promise<ResponseList<SystemPlaceholder>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<SystemPlaceholder>>
See
https://support.crowdin.com/developer/api/v2/#tag/Placeholders/operation/api.projects.system-placeholders.getMany
- Defined in placeholders/index.ts:129

systemPlaceholdersBatchOperations

systemPlaceholdersBatchOperations(projectId, request): Promise<ResponseList<SystemPlaceholder>>
Parameters
- projectId: number
  project identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseList<SystemPlaceholder>>
See
https://support.crowdin.com/developer/api/v2/#tag/Placeholders/operation/api.projects.system-placeholders.batchPatch
- Defined in placeholders/index.ts:142

withFetchAll

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

Class Placeholders

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Placeholders

Methods

addCustomPlaceholder

Parameters

Returns Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>

See

addProjectPlaceholder

Parameters

Returns Promise<ResponseObject<ProjectPlaceholder>>

See

deleteCustomPlaceholder

Parameters

Returns Promise<void>

See

deleteProjectPlaceholder

Parameters

Returns Promise<void>

See

editCustomPlaceholder

Parameters

Returns Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>

See

editProjectPlaceholder

Parameters

Returns Promise<ResponseObject<ProjectPlaceholder>>

See

getCustomPlaceholder

Parameters

Returns Promise<ResponseObject<PlaceholdersModel.CustomPlaceholder>>

See

getProjectPlaceholder

Parameters

Returns Promise<ResponseObject<ProjectPlaceholder>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listCustomPlaceholders

Parameters

Returns Promise<ResponseList<PlaceholdersModel.CustomPlaceholder>>

See

listProjectPlaceholders

Parameters

Returns Promise<ResponseList<ProjectPlaceholder>>

See

listSystemPlaceholders

Parameters

Returns Promise<ResponseList<SystemPlaceholder>>

See

systemPlaceholdersBatchOperations

Parameters

Returns Promise<ResponseList<SystemPlaceholder>>

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string