Function: deviceinfo.SetDeviceProperties

Let a mobile device send generic properties about itself to the server.

Requires AOP API version wg 0.4.8 or later.

Syntax

{
	"method": "deviceinfo.SetDeviceProperties",
	"params": {
		"properties": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<void> SetDeviceProperties( AdvObject properties );
public Task SetDevicePropertiesAsync(IDictionary<string, object?> properties, CancellationToken ct = default);
setDeviceProperties(properties: Map<string, Object>): Promise<>;

Parameters

properties : value{}

Result : void

Errors

DeviceInfo.SetDeviceProperties.NoDeviceIdSet

No Device ID has been set for this connection. Use deviceinfo.SetDeviceId before calling this function.

Remarks

This method requires API write access.

Known Properties

In general, all properties are accepted but only the following properties are saved in the state of the corresponding device Datapoint :

  • “BatteryLevel” (Type: float)
    • Must be between 0.0 and 1.0
    • Is set as the Datapoint state text
  • “IsCharging” (Type: bool)
    • True if battery is currently charging.
  • “IsConnectedToPowerSource” (Type: bool)
    • True if device is connected to power, but not charging.
    • If true, appends the suffix “Power” to the Datapoint state text
  • “GeoPos” (Type: GeoPosition)
    • Updates the latitude and longitude of this device for use in GIS graphics
  • “LocationPrecision” (Type: float)
    • In meters, with fractions (e.g. 0.2m).
  • “DeviceName” (Type: string)
    • E.g. “Guard Phone 3”
  • “DeviceModel” (Type: string)
    • E.g. “Apple iPhone XS”
  • “OSName” (Type: string)
    • E.g. “iOS”
  • “OSVersion” (Type:string)
    • E.g. “18.3”