new ChinoAPIBlobs(baseUrl, customerId, customerKey)
Create a caller for Groups Chino APIs
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
baseUrl |
string | The url endpoint for APIs |
|
customerId |
string | The Chino customer id or bearer token |
|
customerKey |
string | null | null | The Chino customer key or null (not provided) |
Methods
delete(blobId) → {Promise.<objects.Success, objects.ChinoException>}
Delete blob selected by its id
Parameters:
| Name | Type | Description |
|---|---|---|
blobId |
string |
Returns:
A promise that return a Success object if resolved, otherwise throw an ChinoException object if rejected or was not retrieved a success status
- Type
- Promise.<objects.Success, objects.ChinoException>
download(blobId, newFileName) → {Promise.<objects.Success, Error>}
Retrieve selected blob data and save it in the specified file
Parameters:
| Name | Type | Description |
|---|---|---|
blobId |
string | |
newFileName |
string |
Returns:
A promise that return Blob object as Octet stream if resolved, otherwise throw an ChinoException object if rejected
- Type
- Promise.<objects.Success, Error>
upload(docId, field, fileName) → {Promise.<objects.Blob, objects.ChinoException>}
Upload a blob file
Parameters:
| Name | Type | Description |
|---|---|---|
docId |
string | |
field |
string | |
fileName |
string |
Returns:
A promise that return a BlobUncommitted object if resolved, otherwise throw an ChinoException object if rejected or was not retrieved a success status
- Type
- Promise.<objects.Blob, objects.ChinoException>