Class InventoryBinaryService

Hierarchy

Service<IManagedObjectBinary>
- InventoryBinaryService

Index

Constructors

Methods

create delete download getIdFromUrl list

Constructors

constructor

new InventoryBinaryService(client: IFetchClient, realtime?: Realtime): InventoryBinaryService
Parameters
- client: IFetchClient
- Optional realtime: Realtime
Returns InventoryBinaryService
Inherited from Service.constructor
- Defined in packages/client/src/core/Service.ts:18

Methods

create

create(file: Blob | Stream | Buffer | File, managedObject?: Partial<IManagedObject>): Promise<IResult<IManagedObjectBinary>>
Uploads a file and creates a managed object with its metadata.
Parameters
- file: Blob | Stream | Buffer | File
  
  A file to be uploaded.
- managedObject: Partial<IManagedObject> = {}
  
  An object containing metadata about the file. Note that you can specify fileType and fileName in case file does not define them but these two properties will be removed from managedObject before saving.
Returns Promise<IResult<IManagedObjectBinary>>
Overrides Service.create
- Defined in packages/client/src/inventory/InventoryBinaryService.ts:19

delete

delete(managedObjectOrId: IdReference): Promise<IResult<null>>
Parameters
- managedObjectOrId: IdReference
Returns Promise<IResult<null>>
Overrides Service.delete
- Defined in packages/client/src/inventory/InventoryBinaryService.ts:70

download

download(managedObjectOrId: IdReference, init?: IFetchOptions): Promise<IFetchResponse>
Parameters
- managedObjectOrId: IdReference
- Optional init: IFetchOptions
Returns Promise<IFetchResponse>
- Defined in packages/client/src/inventory/InventoryBinaryService.ts:74

getIdFromUrl

getIdFromUrl(url: string): string
Gets binary managed object's id from its download or self URL.

Returns
Binary managed object's id.

Example
```
  const id = InventoryBinaryService.getIdFromUrl('http://mytenant.cumulocity.com/inventory/binaries/12345');
```
Parameters
- url: string
  
  URL string.
Returns string
- Defined in packages/client/src/inventory/InventoryBinaryService.ts:92

list

list(filter?: object): Promise<IResultList<IManagedObjectBinary>>
Parameters
- filter: object = {}
Returns Promise<IResultList<IManagedObjectBinary>>
Overrides Service.list
- Defined in packages/client/src/inventory/InventoryBinaryService.ts:66