Class Labels

Hierarchy (view full)

CrowdinApi
- Labels

Index

Constructors

Methods

addLabel assignLabelToScreenshots assignLabelToString deleteLabel editLabel getLabel graphql listLabels unassignLabelFromScreenshots unassignLabelFromString withFetchAll

Constructors

constructor

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

Methods

addLabel

addLabel(projectId, request): Promise<ResponseObject<Label>>
Parameters
- projectId: number
  project identifier
- request: AddLabelRequest
  request body
Returns Promise<ResponseObject<Label>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.post
- Defined in labels/index.ts:38

assignLabelToScreenshots

assignLabelToScreenshots(projectId, labelId, request): Promise<ResponseList<Screenshot>>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
- request: AssignLabelToScreenshotsRequet
  request body
Returns Promise<ResponseList<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.screenshots.post
- Defined in labels/index.ts:80

assignLabelToString

assignLabelToString(projectId, labelId, request): Promise<ResponseList<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
- request: AssignLabelToStringsRequet
  request body
Returns Promise<ResponseList<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.strings.post
- Defined in labels/index.ts:111

deleteLabel

deleteLabel(projectId, labelId): Promise<void>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.delete
- Defined in labels/index.ts:58

editLabel

editLabel(projectId, labelId, request): Promise<ResponseObject<Label>>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Label>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.patch
- Defined in labels/index.ts:69

getLabel

getLabel(projectId, labelId): Promise<ResponseObject<Label>>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
Returns Promise<ResponseObject<Label>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.get
- Defined in labels/index.ts:48

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

listLabels

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

See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.getMany
- Defined in labels/index.ts:19

unassignLabelFromScreenshots

unassignLabelFromScreenshots(projectId, labelId, screenshotIds): Promise<ResponseList<Screenshot>>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
- screenshotIds: string
  screenshot identifiers
Returns Promise<ResponseList<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.screenshots.deleteMany
- Defined in labels/index.ts:95

unassignLabelFromString

unassignLabelFromString(projectId, labelId, stringIds): Promise<ResponseList<SourceStringsModel.String>>
Parameters
- projectId: number
  project identifier
- labelId: number
  label identifier
- stringIds: string
  string identifiers
Returns Promise<ResponseList<SourceStringsModel.String>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.labels.strings.deleteMany
- Defined in labels/index.ts:126

withFetchAll

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

Class Labels

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Labels

Methods

addLabel

Parameters

Returns Promise<ResponseObject<Label>>

See

assignLabelToScreenshots

Parameters

Returns Promise<ResponseList<Screenshot>>

See

assignLabelToString

Parameters

Returns Promise<ResponseList<SourceStringsModel.String>>

See

deleteLabel

Parameters

Returns Promise<void>

See

editLabel

Parameters

Returns Promise<ResponseObject<Label>>

See

getLabel

Parameters

Returns Promise<ResponseObject<Label>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listLabels

Parameters

Returns Promise<ResponseList<Label>>

See

Parameters

Returns Promise<ResponseList<Label>>

Deprecated

See

unassignLabelFromScreenshots

Parameters

Returns Promise<ResponseList<Screenshot>>

See

unassignLabelFromString

Parameters

Returns Promise<ResponseList<SourceStringsModel.String>>

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string