DeviceManagement class
Device management functions are handled through the device service. The device service is the entry point to all other services provided by a device.
Default Access Policy Definition | | Administrator | Operator | User | Anonymous | | PRE_AUTH | X | X | X | X | | READ_SYSTEM | X | X | X | | | READ_SYSTEM_SENSITIVE | X | X | | | | READ_SYSTEM_SECRET | X | | | | | WRITE_SYSTEM | X | | | | | UNRECOVERABLE | X | | | | | READ_MEDIA | X | X | X | | | ACTUATE | X | X | | |
- Mixed in types
-
- UiLoggy
Constructors
- DeviceManagement({required Transport transport, required Uri uri})
Properties
Methods
-
createUsers(
List< User> users) → Future<bool> - This operation creates new device users and corresponding credentials on a device for authentication purposes. The device shall support creation of device users and their credentials through the CreateUsers command. Either all users are created successfully or a fault message shall be returned without creating any user.
-
deleteUsers(
List< String> users) → Future<bool> - This operation deletes users on a device. The device shall support deletion of device users and their credentials through the DeleteUsers command. A device may have one or more fixed users that cannot be deleted to ensure access to the unit. Either all users are deleted successfully or a fault message shall be returned and no users be deleted.
-
getCapabilities(
{CapabilityCategory? capabilityCategory}) → Future< Capabilities> - This operation creates new device users and corresponding credentials on a device for authentication purposes. The device shall support creation of device users and their credentials through the CreateUsers command. Either all users are created successfully or a fault message shall be returned without creating any user.
-
getDeviceInformation(
) → Future< GetDeviceInformationResponse> - This operation gets basic device information from the device.
-
getDiscoveryMode(
) → Future< String> - This operation gets the discovery mode of a device. See Section 7.2 for the definition of the different device discovery modes. The device shall support retrieval of the discovery mode setting through the GetDiscoveryMode command.
-
getDns(
) → Future< DnsInformation> - This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.
-
getEndpointReference(
) → Future< Map< String, dynamic> > - Access Class: READ_SYSTEM A client can ask for the device service endpoint reference address property that can be used to derive the password equivalent for remote user operation. The device shall support the GetEndpointReference command returning the address property of the device service endpoint reference.
-
getHostname(
) → Future< HostnameInformation> - This operation is used by an endpoint to get the hostname from a device. The device shall return its hostname configurations through the getHostname
-
getNetworkProtocols(
) → Future< List< NetworkProtocol> > - This operation gets defined network protocols from a device. The device shall support the getNetworkProtocols command returning configured network protocols.
-
getNtp(
) → Future< NtpInformation> - This operation gets the NTP settings from a device. If the device supports NTP, it shall be possible to get the NTP server settings through the getNtp command.
-
getServiceCapabilities(
) → Future< DeviceServiceCapabilities> - Returns the capabilities of the device service. The result is returned in a typed answer.
-
getServices(
[bool includeCapability = false]) → Future< List< Service> > - Returns information about services on the device.
-
getStorageConfiguration(
String referenceToken) → Future< StorageConfiguration> - This operation retrieves the Storage configuration associated with the given storage configuration token
-
getStorageConfigurations(
) → Future< List< StorageConfiguration> > - This operation lists all existing storage configurations for the device.
-
getSystemDateAndTime(
) → Future< SystemDateAndTime> - This operation gets the device system date and time. The device shall support the return of the daylight saving setting and of the manual system date and time (if applicable) or indication of NTP time (if applicable) through the getSystemDateAndTime command.
-
getSystemLog(
String logType, {Directory? writeLogToFolder}) → Future< SystemInformation> - This operation gets a system log from the device. The exact format of the system logs is outside the scope of this standard however a common format for the system log response is SOAP Message Transmission Optimization Mechanism (MTOM) which is the use of MIME to optimize the bit stream transmission of SOAP messages that contain significantly large base64Binary elements.
-
getSystemSupportInformation(
{Directory? writeLogToFolder}) → Future< SystemInformation> - This operation gets arbitrary device diagnostics information from the device.
-
getSystemUris(
) → Future< GetSystemUrisResponse?> - This operation is used to retrieve URIs from which system information may be downloaded using HTTP. URIs may be returned for the following system information:
-
getUsers(
) → Future< List< User> > - This operation lists the registered users and corresponding credentials on a device. The device shall support retrieval of registered device users and their credentials for the user token through the getUsers (GetUsers) command.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
systemReboot(
) → Future< String> - This operation reboots the device.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited