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 listScreenshotTags listScreenshots replaceTags updateScreenshot updateTag withFetchAll

Constructors

constructor

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

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

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

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

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

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

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

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

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

graphql

graphql<T>(req): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - Optional operationName?: string
  - query: string
  - Optional variables?: any
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:256

listScreenshotTags

listScreenshotTags(projectId, screenshotId, options?): Promise<ResponseList<Tag>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- Optional options: 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:115
listScreenshotTags(projectId, screenshotId, limit?, offset?): Promise<ResponseList<Tag>>
Parameters
- projectId: number
  project identifier
- screenshotId: number
  screenshot identifier
- Optional limit: number
  maximum number of items to retrieve (default 25)
- Optional offset: 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:128

listScreenshots

listScreenshots(projectId, options?): Promise<ResponseList<Screenshot>>
Parameters
- projectId: number
  project identifier
- Optional options: 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
- Optional limit: number
  maximum number of items to retrieve (default 25)
- Optional offset: 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

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

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

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

withFetchAll

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

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

Optional operationName?: string

query: string

Optional variables?: any

Returns Promise<ResponseObject<T>>

listScreenshotTags

Parameters

Returns Promise<ResponseList<Tag>>

See

Parameters

Returns Promise<ResponseList<Tag>>

Deprecated

See

listScreenshots

Parameters

Returns Promise<ResponseList<Screenshot>>

See

Parameters

Returns Promise<ResponseList<Screenshot>>

Deprecated

See

replaceTags

Parameters

Returns Promise<void>

See

updateScreenshot

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

updateTag

Parameters

Returns Promise<ResponseObject<Screenshot>>

See

withFetchAll

Parameters

Returns this

`Optional` operationName?: string

`Optional` variables?: any