Web SDK documentation
  1. Injectables
  2. DeviceProfileService

File

device-profile/device-profile.service.ts

Index

Properties
Methods

Constructor

constructor(inventoryService: InventoryService, operationService: OperationService, alertService: AlertService)
Parameters :
Name Type Optional
inventoryService InventoryService No
operationService OperationService No
alertService AlertService No

Methods

alignSoftwareTypeFragments
alignSoftwareTypeFragments(profilePartial: Partial<DeviceProfile>, profile: DeviceProfile)

Aligns device profile managed object's softwareType!* fragments to the software items included in the device profile. Removes obsolete software type fragments and adds new.

Parameters :
Name Type Optional Description
profilePartial Partial<DeviceProfile> No

The device profile managed object which softwareType!* fragments will be adjusted.
profile DeviceProfile No
Returns : Partial<DeviceProfile>

The adjusted device profile managed object.
createDeviceProfile
createDeviceProfile(deviceProfile: Partial<DeviceProfile>)
Parameters :
Name Type Optional
deviceProfile Partial<DeviceProfile> No
Returns : any
Async createProfileOperation
createProfileOperation(device: IManagedObject, deviceProfile: Partial<DeviceProfile>)
Parameters :
Name Type Optional
device IManagedObject No
deviceProfile Partial<DeviceProfile> No
Returns : unknown
getConfigurationItems
getConfigurationItems(device: IManagedObject, selectedProfile: Partial<DeviceProfile>)
Parameters :
Name Type Optional
device IManagedObject No
selectedProfile Partial<DeviceProfile> No
Returns : ComparisonResult[]
getDeviceProfiles
getDeviceProfiles(andQuery?: any)
Parameters :
Name Type Optional
andQuery any Yes
Returns : Promise<IResultList<IManagedObject>>
getDeviceProfilesByDevice
getDeviceProfilesByDevice(device: IManagedObject, name: string)

Determines the available device profiles for a given device by considering device type and the supported software types declared by the devices. Because of limitations in the Inventory Query API the methods return profile that contain at least one of the supported software types and omits profiles having only non-supported software types. Resulting device profiles need to be further filtered on the client side to exclude the ones that contain non-supported software types next to the supported ones.

Parameters :
Name Type Optional Default value Description
device IManagedObject No

A device MO
name string No null

Optional device profile name filter
Returns : Promise<IResultList<IManagedObject>>

Candidate device profiles that contain at least on software with supported type.
getDeviceProfilesByDeviceType
Use `getDeviceProfilesByDevice` instead as it also considers the supported software types.
getDeviceProfilesByDeviceType(deviceType: string)
Parameters :
Name Type Optional
deviceType string No
Returns : Promise<IResultList<IManagedObject>>
getFirmwareItems
getFirmwareItems(device: IManagedObject, selectedProfile: Partial<DeviceProfile>)
Parameters :
Name Type Optional
device IManagedObject No
selectedProfile Partial<DeviceProfile> No
Returns : ComparisonResult[]
Async getProfileOperation
getProfileOperation(deviceId: string | number)
Parameters :
Name Type Optional
deviceId string | number No
Returns : unknown
getSoftwareItems
getSoftwareItems(device: IManagedObject, selectedProfile: Partial<DeviceProfile>)
Parameters :
Name Type Optional
device IManagedObject No
selectedProfile Partial<DeviceProfile> No
Returns : ComparisonResult[]
getSoftwareTypes
getSoftwareTypes(profile: DeviceProfile)
Parameters :
Name Type Optional
profile DeviceProfile No
Returns : string[]

Properties

Readonly dateFrom
Default value : new Date(0)
Readonly dateTo
Default value : new Date(Date.now() + 86400000)

results matching ""

    No results matching ""