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
- Optional config: ClientConfig
  optional configuration of the client
Returns Applications
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:222

Methods

addApplicationData

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

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

deleteApplicationInstallation

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

editApplicationData

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

editApplicationInstallation

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

getApplicationData

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

getApplicationInstallation

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

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

installApplication

installApplication(applicationUrl, permissions?): Promise<ResponseObject<ApplicationData>>
Parameters
- applicationUrl: string
  Manifest URL
- Optional permissions: ApplicationPermissions
  application permissions
Returns Promise<ResponseObject<ApplicationData>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.installations.post
- Defined in applications/index.ts:23

listApplicationInstallations

listApplicationInstallations(options?): Promise<ResponseObject<ApplicationData>>
Parameters
- Optional options: Pagination
  optional pagination parameters for the request
Returns Promise<ResponseObject<ApplicationData>>
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<ApplicationData>>
Parameters
- applicationId: string
  application identifier
- path: string
  path implemented by the application
- request: ApplicationData
  request body
Returns Promise<ResponseObject<ApplicationData>>
See
https://developer.crowdin.com/api/v2/#operation/api.applications.api.put
- Defined in applications/index.ts:88

withFetchAll

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