Class InventoryBinaryService

Hierarchy

Service<IManagedObjectBinary>
- InventoryBinaryService

Index

Constructors

constructor

Methods

Constructors

constructor

new InventoryBinaryService(client: IFetchClient, realtime?: Realtime): InventoryBinaryService

Inherited from Service.constructor
- Defined in core/Service.ts:16
Parameters
- client: IFetchClient
- Optional realtime: Realtime
Returns InventoryBinaryService

Methods

create

create(file: Stream | Buffer | File | Blob, managedObject?: Partial<IManagedObject>): Promise<IResult<IManagedObjectBinary>>

- Defined in inventory/InventoryBinaryService.ts:19
Parameters
- file: Stream | Buffer | File | Blob
- Default value managedObject: Partial<IManagedObject> = {}
Returns Promise<IResult<IManagedObjectBinary>>

delete

delete(managedObjectOrId: IdReference): Object

- Defined in inventory/InventoryBinaryService.ts:70
Parameters
- managedObjectOrId: IdReference
Returns Object

download

download(managedObjectOrId: IdReference): Promise<IFetchResponse>

- Defined in inventory/InventoryBinaryService.ts:74
Parameters
- managedObjectOrId: IdReference
Returns Promise<IFetchResponse>

getIdFromUrl

getIdFromUrl(url: string): string

- Defined in inventory/InventoryBinaryService.ts:92
Parameters
- url: string
Returns string

Binary managed object's id.

Example
```
  const id = InventoryBinaryService.getIdFromUrl('http://mytenant.cumulocity.com/inventory/binaries/12345');
```

list

list(filter?: object): Object

Overrides Service.list
- Defined in inventory/InventoryBinaryService.ts:66
Parameters
- Default value filter: object = {}
Returns Object

Generated using TypeDoc