iotfileservices-sdk 3.2.0

iotfileservices-sdk

3.2.0

FileServiceClient ▸
- Instance members
- #deleteFile
- #getFile
- #getFileList
- #putFile
- #searchFiles
- #handleFileOperation
- #initiateMultiPartUpload
- #createMultiPartFile
- #completeMultiPartUpload
- #abortMultiPartUpload
- #updateMultiPartFile

Need help reading this?

FileServiceClient

new FileServiceClient(clientConfig: ClientConfig, mindsphereCredentials: MindsphereCredentials)

Parameters

clientConfig (ClientConfig)

mindsphereCredentials (MindsphereCredentials)

Instance Members

▸ deleteFile(requestObject)

delete a file Delete a file for the specified entity and path.

deleteFile(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are entityId ,filepath } no response value expected for this operation *

▸ getFile(requestObject)

read a file Read a file for the specified entity and path

getFile(requestObject: JSON): Promise

Parameters

requestObject (JSON) {Keys are entityId ,filepath ,ifNoneMatch,range}

Returns

Promise: byte[] of type JSON *

▸ getFileList(requestObject)

list multi part uploads List multi part uploads

getFileList(requestObject: JSON): Promise

Parameters

requestObject (JSON) {Keys are entityId ,filepath }

Returns

Promise: List of type JSON *

▸ putFile(requestObject)

write a file Create or update a file for the specified entity and path, with the provided content.

putFile(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are file ,entityId ,filepath ,part,upload,ifMatch,timestamp,description,type} no response value expected for this operation

▸ searchFiles(requestObject)

search files Search files for the specified entity.

searchFiles(requestObject: JSON): Promise

Parameters

requestObject (JSON) {Keys are entityId*,offset,limit,count,order,filter}

Returns

Promise: List of type JSON *

▸ handleFileOperation(requestObject)

Initiates/ completes/ aborts uploading a file.

For initiating , completing, aborting file upload user can send flags "start", "complete" and "abort" in key "upload".

handleFileOperation(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are file,entityId ,filepath ,part,upload,ifMatch,timestamp,description,type} no response value expected for this operation *

▸ initiateMultiPartUpload(requestObject)

Initiate uploading of a file in multiple parts.

initiateMultiPartUpload(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are entityId ,filepath ,ifMatch,timestamp,description,type} no response value expected for this operation *

▸ createMultiPartFile(requestObject)

Create a file by uploading multiple parts of the file.

createMultiPartFile(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are file ,entityId ,filepath ,part ,upload,timestamp,description,type} no response value expected for this operation *

▸ completeMultiPartUpload(requestObject)

Completes multiple file upload .

completeMultiPartUpload(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are entityId ,filepath ,file,timestamp,description,type} no response value expected for this operation *

▸ abortMultiPartUpload(requestObject)

Aborts a multi part file upload.

abortMultiPartUpload(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are entityId ,filepath ,timestamp,description,type} no response value expected for this operation *

▸ updateMultiPartFile(requestObject)

Updates a file by uploading multiple parts of the file.

updateMultiPartFile(requestObject: JSON)

Parameters

requestObject (JSON) {Keys are file ,entityId ,filepath ,part ,ifMatch ,upload,timestamp,description,type} no response value expected for this operation