io.github.privacystreams.device

Class DeviceState

java.lang.Object

io.github.privacystreams.core.Item

io.github.privacystreams.device.DeviceState

@PSItem
public class DeviceState
extends Item

A DeviceEvent item represents a snapshot of device state.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceState.Masks

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BATTERY_LEVEL The current battery level.
static java.lang.String	BLUETOOTH_DEVICE_LIST The list of currently scanned bluetooth device.
static java.lang.String	IS_CONNECTED Whether the current device is connected to network
static java.lang.String	IS_SCREEN_ON Whether the screen is on
static java.lang.String	WIFI_AP_LIST The list of currently scanned Wifi APs.
static java.lang.String	WIFI_BSSID The connected WiFi AP BSSID, could be null if the device is not connected to WiFi

Fields inherited from class io.github.privacystreams.core.Item

EOS, TIME_CREATED

Constructor Summary

Constructors

Constructor and Description
DeviceState()

Method Summary

Modifier and Type	Method and Description
static PStreamProvider	asUpdates(long interval, int mask) Provide a live stream of device states, including bluetooth, wifi, battery level, and/or foreground apps etc.

Methods inherited from class io.github.privacystreams.core.Item

containsField, equals, excludeFields, getAsBoolean, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValueByField, includeFields, isEndOfStream, setFieldValue, toDebugString, toJson, toMap, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLUETOOTH_DEVICE_LIST

@PSItemField(type=java.util.List.class)
public static final java.lang.String BLUETOOTH_DEVICE_LIST

The list of currently scanned bluetooth device.

See Also:

Constant Field Values

WIFI_AP_LIST

@PSItemField(type=java.util.List.class)
public static final java.lang.String WIFI_AP_LIST

The list of currently scanned Wifi APs.

See Also:

Constant Field Values

BATTERY_LEVEL

@PSItemField(type=java.lang.Float.class)
public static final java.lang.String BATTERY_LEVEL

The current battery level.

See Also:

Constant Field Values

IS_CONNECTED

@PSItemField(type=java.lang.Boolean.class)
public static final java.lang.String IS_CONNECTED

Whether the current device is connected to network

See Also:

Constant Field Values

WIFI_BSSID

@PSItemField(type=java.lang.String.class)
public static final java.lang.String WIFI_BSSID

The connected WiFi AP BSSID, could be null if the device is not connected to WiFi

See Also:

Constant Field Values

IS_SCREEN_ON

@PSItemField(type=java.lang.String.class)
public static final java.lang.String IS_SCREEN_ON

Whether the screen is on

See Also:

Constant Field Values

Constructor Detail

DeviceState

public DeviceState()

Method Detail

asUpdates

public static PStreamProvider asUpdates(long interval,
                                        int mask)

Provide a live stream of device states, including bluetooth, wifi, battery level, and/or foreground apps etc.

Parameters:

interval - the interval between each two device state snapshots

mask - the mask of device state type, could be `DeviceState.Masks.BLUETOOTH_DEVICE_LIST`, `DeviceState.Masks.WIFI_AP_LIST`, etc.

Returns:

the provider function