Class StringComments

Use API to list, add, get, edit or delete string comments.

Hierarchy (view full)

CrowdinApi
- StringComments

Index

Constructors

constructor

Methods

addStringComment deleteStringComment editStringComment getStringComment graphql listStringComments withFetchAll

Constructors

constructor

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

Methods

addStringComment

addStringComment(projectId, request): Promise<ResponseObject<StringComment>>
Parameters
- projectId: number
  project identifier
- request: AddStringCommentRequest
  request body
Returns Promise<ResponseObject<StringComment>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.comments.post
- Defined in stringComments/index.ts:66

deleteStringComment

deleteStringComment(projectId, stringCommentId): Promise<void>
Parameters
- projectId: number
  project identifier
- stringCommentId: number
  string comment identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.comments.delete
- Defined in stringComments/index.ts:92

editStringComment

editStringComment(projectId, stringCommentId, request): Promise<ResponseObject<StringComment>>
Parameters
- projectId: number
  project identifier
- stringCommentId: number
  string comment identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<StringComment>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.comments.patch
- Defined in stringComments/index.ts:103

getStringComment

getStringComment(projectId, stringCommentId): Promise<ResponseObject<StringComment>>
Parameters
- projectId: number
  project identifier
- stringCommentId: number
  string comment identifier
Returns Promise<ResponseObject<StringComment>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.comments.get
- Defined in stringComments/index.ts:79

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

listStringComments

listStringComments(projectId, options?): Promise<ResponseList<StringComment>>
Parameters
- projectId: number
  project identifier
- Optional options: ListStringCommentsOptions
  optional parameters for the requesr
Returns Promise<ResponseList<StringComment>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.comments.getMany
- Defined in stringComments/index.ts:12
listStringComments(projectId, stringId?, type?, targetLanguageId?, issueType?, issueStatus?): Promise<ResponseList<StringComment>>
Parameters
- projectId: number
  project identifier
- Optional stringId: number
  string identifier
- Optional type: StringCommentsModel.Type
  defines string comment type
- Optional targetLanguageId: string
  defines target language id. It can be one target language id or a list of comma-separated ones
- Optional issueType: IssueType
  defines issue type. It can be one issue type or a list of comma-separated ones
- Optional issueStatus: IssueStatus
  defines issue resolution status
Returns Promise<ResponseList<StringComment>>
Deprecated
optional parameters should be passed through an object

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

withFetchAll

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

Class StringComments

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns StringComments

Methods

addStringComment

Parameters

Returns Promise<ResponseObject<StringComment>>

See

deleteStringComment

Parameters

Returns Promise<void>

See

editStringComment

Parameters

Returns Promise<ResponseObject<StringComment>>

See

getStringComment

Parameters

Returns Promise<ResponseObject<StringComment>>

See

graphql

Type Parameters

Parameters

Optional operationName?: string

query: string

Optional variables?: any

Returns Promise<ResponseObject<T>>

listStringComments

Parameters

Returns Promise<ResponseList<StringComment>>

See

Parameters

Returns Promise<ResponseList<StringComment>>

Deprecated

See

withFetchAll

Parameters

Returns this

Settings

Member Visibility

Theme

On This Page

`Optional` operationName?: string

`Optional` variables?: any