LicenseSpring Management .Net SDK 1.10.1
Easily add Software Licensing to your application
Loading...
Searching...
No Matches
LicenseSpring.DeviceService Class Reference

Implements IDeviceService interface. More...

Inheritance diagram for LicenseSpring.DeviceService:
LicenseSpring.BaseService LicenseSpring.IDeviceService LicenseSpring.IService LicenseSpring.IService

Public Member Functions

string BlacklistDevice (ulong deviceId)
 Blacklist a single Device if requesting manager has access permissions to it.
Parameters
deviceIdThe Id of the device that will be blacklisted.

 
DateTime BorrowDevice (ulong deviceId, DateTime? borrowUntil=null)
 Borrow a single Device if requesting manager has access permissions to it.
Parameters
deviceIdThe Id of the device that will be borrowed.
borrowUntilDateTime until which device will be borrowed.Set null as a value if you want to manually return the borrowed license.

 
DeviceVariable CreateDeviceVariable (CreateDeviceVariableDto dto)
 Creates a new device variable.
Parameters
dtoDto with information about new device variable.

 
string DeleteDeviceVariable (uint variableId)
 Deletes device variable.
Parameters
variableIdThe Id of the device variable that will be deleted.

 
Device[] ListDevices (ListDevicesRequestDto dto, out uint Count)
 Returns all devices.
Parameters
dtoData transfer object that is used for searching through all devices.
countQuantity of devices, use for iteration of the result pages.

 
DeviceVariable[] ListDeviceVariables (ListDeviceVariablesRequestDto dto, out uint count)
 Returns all device variables.
Parameters
dtoData transfer object that is used for searching through device variables.
countQuantity of variables, use for iteration of the result pages.

 
string ResetDevice (ulong deviceId)
 Reset a single Device if requesting manager has access permissions to it.
Parameters
deviceIdThe Id of the device that will be reset.

 
DeviceVariable UpdateDeviceVariable (CreateDeviceVariableDto dto, uint variableId)
 Updates device variable.
Parameters
dtoDto with information about device variable that will be updated.
variableIdThe Id of the device variable that will be updated.

 
- Public Member Functions inherited from LicenseSpring.BaseService
void Initialize (ManagementConfiguration configuration)
 Initialize management service with given configuration.
Parameters
configurationManagementConfiguration object to use
Exceptions
System.ArgumentNullExceptionThrown when configuration is null

 
bool IsInitialized ()
 Check whether management service has been initialized.
Returns
True if management service has been initialized and ready to use or false otherwise

 
bool IsOnline (bool throwExceptions=false)
 Helper method, it checks connection to the LicenseSpring platform.
Parameters
throwExceptionsBoolean value indicating whether this method should throw exceptions, by default it's false.
Returns
True if SDK is able to connect to the LicenseSpring platform and false otherwise.
Exceptions
System.InvalidOperationExceptionThrown when license manager is not initialized
LicenseSpring.NetworkExceptionIn case of network errors, e.g. no Internet connection or operation timed out.

 

Detailed Description

Implements IDeviceService interface.

Member Function Documentation

◆ BlacklistDevice()

string LicenseSpring.DeviceService.BlacklistDevice ( ulong  deviceId)

Blacklist a single Device if requesting manager has access permissions to it.

Parameters
deviceIdThe Id of the device that will be blacklisted.

Implements LicenseSpring.IDeviceService.

◆ BorrowDevice()

DateTime LicenseSpring.DeviceService.BorrowDevice ( ulong  deviceId,
DateTime?  borrowUntil = null 
)

Borrow a single Device if requesting manager has access permissions to it.

Parameters
deviceIdThe Id of the device that will be borrowed.
borrowUntilDateTime until which device will be borrowed.Set null as a value if you want to manually return the borrowed license.

Implements LicenseSpring.IDeviceService.

◆ CreateDeviceVariable()

DeviceVariable LicenseSpring.DeviceService.CreateDeviceVariable ( CreateDeviceVariableDto  dto)

Creates a new device variable.

Parameters
dtoDto with information about new device variable.

Implements LicenseSpring.IDeviceService.

◆ DeleteDeviceVariable()

string LicenseSpring.DeviceService.DeleteDeviceVariable ( uint  variableId)

Deletes device variable.

Parameters
variableIdThe Id of the device variable that will be deleted.

Implements LicenseSpring.IDeviceService.

◆ ListDevices()

Device[] LicenseSpring.DeviceService.ListDevices ( ListDevicesRequestDto  dto,
out uint  Count 
)

Returns all devices.

Parameters
dtoData transfer object that is used for searching through all devices.
countQuantity of devices, use for iteration of the result pages.

Implements LicenseSpring.IDeviceService.

◆ ListDeviceVariables()

DeviceVariable[] LicenseSpring.DeviceService.ListDeviceVariables ( ListDeviceVariablesRequestDto  dto,
out uint  count 
)

Returns all device variables.

Parameters
dtoData transfer object that is used for searching through device variables.
countQuantity of variables, use for iteration of the result pages.

Implements LicenseSpring.IDeviceService.

◆ ResetDevice()

string LicenseSpring.DeviceService.ResetDevice ( ulong  deviceId)

Reset a single Device if requesting manager has access permissions to it.

Parameters
deviceIdThe Id of the device that will be reset.

Implements LicenseSpring.IDeviceService.

◆ UpdateDeviceVariable()

DeviceVariable LicenseSpring.DeviceService.UpdateDeviceVariable ( CreateDeviceVariableDto  dto,
uint  variableId 
)

Updates device variable.

Parameters
dtoDto with information about device variable that will be updated.
variableIdThe Id of the device variable that will be updated.

Implements LicenseSpring.IDeviceService.


The documentation for this class was generated from the following file: