Class Applications

Crowdin Apps are web applications that can be integrated with Crowdin to extend its functionality.

Use the API to manage the necessary app data.

Hierarchy (view full)

CrowdinApi
- Applications

Index

Constructors

Methods

addApplicationData deleteApplicationData deleteApplicationInstallation editApplicationData editApplicationInstallation getApplicationData getApplicationInstallation graphql installApplication listApplicationInstallations updateOrRestoreApplicationData withFetchAll

Constructors

constructor

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

Methods

addApplicationData

addApplicationData(applicationId, path, request): Promise<ResponseObject<any>>
Parameters
- applicationId: string
  application identifier
- path: string
  path implemented by the application
- request: any
  request body
Returns Promise<ResponseObject<any>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.api.post
- Defined in applications/index.ts:94

deleteApplicationData

deleteApplicationData(applicationId, path): Promise<void>
Parameters
- applicationId: string
  application identifier
- path: string
  path implemented by the application
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.api.delete
- Defined in applications/index.ts:104

deleteApplicationInstallation

deleteApplicationInstallation(applicationId, force?): Promise<ResponseObject<Application>>
Parameters
- applicationId: string
  application identifier
- Optionalforce: boolean
  force delete the application
Returns Promise<ResponseObject<Application>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.installations.delete
- Defined in applications/index.ts:43

editApplicationData

editApplicationData(applicationId, path, request): Promise<ResponseObject<any>>
Parameters
- applicationId: string
  application identifier
- path: string
  path implemented by the application
- request: any
  request body
Returns Promise<ResponseObject<any>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.api.patch
- Defined in applications/index.ts:115

editApplicationInstallation

editApplicationInstallation(applicationId, request): Promise<ResponseObject<Application>>
Parameters
- applicationId: string
  application identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Application>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.installations.patch
- Defined in applications/index.ts:59

getApplicationData

getApplicationData(applicationId, path): Promise<ResponseObject<any>>
Parameters
- applicationId: string
  application identifier
- path: string
  path implemented by the application
Returns Promise<ResponseObject<any>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.api.get
- Defined in applications/index.ts:72

getApplicationInstallation

getApplicationInstallation(applicationId): Promise<ResponseObject<Application>>
Parameters
- applicationId: string
  application identifier
Returns Promise<ResponseObject<Application>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.installations.get
- Defined in applications/index.ts:33

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

installApplication

installApplication(request): Promise<ResponseObject<Application>>
Parameters
- request: InstallApplication
  request body
Returns Promise<ResponseObject<Application>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.installations.post
- Defined in applications/index.ts:22

listApplicationInstallations

listApplicationInstallations(options?): Promise<ResponseList<Application>>
Parameters
- Optionaloptions: Pagination
  optional pagination parameters for the request
Returns Promise<ResponseList<Application>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.installations.getMany
- Defined in applications/index.ts:13

updateOrRestoreApplicationData

updateOrRestoreApplicationData(applicationId, path, request): Promise<ResponseObject<any>>
Parameters
- applicationId: string
  application identifier
- path: string
  path implemented by the application
- request: any
  request body
Returns Promise<ResponseObject<any>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.api.put
- Defined in applications/index.ts:83

withFetchAll

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