Class Screenshots

Screenshots provide translators with additional context for the source strings. Screenshot tags allow specifying which source strings are displayed on each screenshot.

Use API to manage screenshots and their tags.

Hierarchy (view full)

CrowdinApi
- Screenshots

Index

Constructors

constructor

Methods

addScreenshot addTag clearTags deleteScreenshot deleteTag editScreenshot getScreenshot getTag graphql listScreenshots listScreenshotTags replaceTags updateScreenshot updateTag withFetchAll

Constructors

constructor

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

Methods

addScreenshot

addScreenshot(projectId, request): Promise<ResponseObject<Screenshot>>
Parameters
- projectId: number
  project identifier
- request: CreateScreenshotRequest
  request body
Returns Promise<ResponseObject<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.post
- Defined in screenshots/index.ts:53

addTag

addTag(projectId, screenshotId, request): Promise<ResponseObject<Tag>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- request: ReplaceTagRequest[]
  request body
Returns Promise<ResponseObject<Tag>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.post
- Defined in screenshots/index.ts:170

clearTags

clearTags(projectId, screenshotId): Promise<void>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.deleteMany
- Defined in screenshots/index.ts:184

deleteScreenshot

deleteScreenshot(projectId, screenshotId): Promise<void>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.delete
- Defined in screenshots/index.ts:91

deleteTag

deleteTag(projectId, screenshotId, tagId): Promise<void>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- tagId: number
  tag identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.delete
- Defined in screenshots/index.ts:206

editScreenshot

editScreenshot(projectId, screenshotId, request): Promise<ResponseObject<Screenshot>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.patch
- Defined in screenshots/index.ts:102

getScreenshot

getScreenshot(projectId, screenshotId): Promise<ResponseObject<Screenshot>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
Returns Promise<ResponseObject<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.get
- Defined in screenshots/index.ts:66

getTag

getTag(projectId, screenshotId, tagId): Promise<ResponseObject<Tag>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- tagId: number
  tag identifier
Returns Promise<ResponseObject<Tag>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.get
- Defined in screenshots/index.ts:195

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

listScreenshots

listScreenshots(projectId, options?): Promise<ResponseList<Screenshot>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListScreenshotParams
  search options
Returns Promise<ResponseList<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.getMany
- Defined in screenshots/index.ts:15
listScreenshots(projectId, limit?, offset?): Promise<ResponseList<Screenshot>>
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<Screenshot>>
Deprecated
optional parameters should be passed through an object

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

listScreenshotTags

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

See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.getMany
- Defined in screenshots/index.ts:130

replaceTags

replaceTags(projectId, screenshotId, request): Promise<void>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- request: AutoTagRequest | ReplaceTagRequest[]
  request body
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.putMany
- Defined in screenshots/index.ts:155

updateScreenshot

updateScreenshot(projectId, screenshotId, request): Promise<ResponseObject<Screenshot>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- request: UpdateScreenshotRequest
  request body
Returns Promise<ResponseObject<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.put
- Defined in screenshots/index.ts:77

updateTag

updateTag(projectId, screenshotId, tagId, request): Promise<ResponseObject<Screenshot>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- tagId: number
  tag identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Screenshot>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.screenshots.tags.patch
- Defined in screenshots/index.ts:218

withFetchAll

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

Class Screenshots

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Screenshots

Methods

addScreenshot

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

addTag

Parameters

Returns Promise<ResponseObject<Tag>>

See

clearTags

Parameters

Returns Promise<void>

See

deleteScreenshot

Parameters

Returns Promise<void>

See

deleteTag

Parameters

Returns Promise<void>

See

editScreenshot

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

getScreenshot

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

getTag

Parameters

Returns Promise<ResponseObject<Tag>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listScreenshots

Parameters

Returns Promise<ResponseList<Screenshot>>

See

Parameters

Returns Promise<ResponseList<Screenshot>>

Deprecated

See

listScreenshotTags

Parameters

Returns Promise<ResponseList<Tag>>

See

Parameters

Returns Promise<ResponseList<Tag>>

Deprecated

See

replaceTags

Parameters

Returns Promise<void>

See

updateScreenshot

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

updateTag

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

withFetchAll

Parameters

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string