Class UploadStorage

Storage is a separate container for each file. You need to use Add Storage method before adding files to your projects via API. Files that should be uploaded into storage include files for localization, screenshots, Glossaries, and Translation Memories.

Storage id is the identifier of the file uploaded to the Storage.

Note: Files uploaded to the storage are kept during the next 24 hours.

Hierarchy (view full)

CrowdinApi
- UploadStorage

Index

Constructors

constructor

Methods

addStorage deleteStorage getStorage graphql listStorages withFetchAll

Constructors

constructor

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

Methods

addStorage

addStorage(fileName, request, contentType?): Promise<ResponseObject<Storage>>
Parameters
- fileName: string
  file name
- request: any
  binary file data
- OptionalcontentType: string
  content type header
Returns Promise<ResponseObject<Storage>>
See
https://developer.crowdin.com/api/v2/#operation/api.storages.post
- Defined in uploadStorage/index.ts:951

deleteStorage

deleteStorage(storageId): Promise<void>
Parameters
- storageId: number
  storage identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.storages.delete
- Defined in uploadStorage/index.ts:988

getStorage

getStorage(storageId): Promise<ResponseObject<Storage>>
Parameters
- storageId: number
  storage identifier
Returns Promise<ResponseObject<Storage>>
See
https://developer.crowdin.com/api/v2/#operation/api.storages.get
- Defined in uploadStorage/index.ts:979

graphql

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

listStorages

listStorages(options?): Promise<ResponseList<Storage>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<Storage>>
See
https://developer.crowdin.com/api/v2/#operation/api.storages.getMany
- Defined in uploadStorage/index.ts:926
listStorages(limit?, offset?): Promise<ResponseList<Storage>>
Parameters
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Storage>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.storages.getMany
- Defined in uploadStorage/index.ts:933

withFetchAll

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

Class UploadStorage

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UploadStorage

Methods

addStorage

Parameters

Returns Promise<ResponseObject<Storage>>

See

deleteStorage

Parameters

Returns Promise<void>

See

getStorage

Parameters

Returns Promise<ResponseObject<Storage>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Returns Promise<ResponseObject<T>>

listStorages

Parameters

Returns Promise<ResponseList<Storage>>

See

Parameters

Returns Promise<ResponseList<Storage>>

Deprecated

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any