io.github.privacystreams.device

Class DeviceEvent

java.lang.Object

io.github.privacystreams.core.Item

io.github.privacystreams.device.DeviceEvent

@PSItem
public class DeviceEvent
extends Item

A DeviceEvent item represents an event about the device.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT The event name.
static java.lang.String	EVENT_BATTERY_AC_CONNECTED
static java.lang.String	EVENT_BATTERY_AC_DISCONNECTED
static java.lang.String	EVENT_BATTERY_LOW
static java.lang.String	EVENT_BATTERY_OKAY
static java.lang.String	EVENT_BOOT_COMPLETED
static java.lang.String	EVENT_BOOT_SHUTDOWN
static java.lang.String	EVENT_RINGER_NORMAL
static java.lang.String	EVENT_RINGER_SILENT
static java.lang.String	EVENT_RINGER_VIBRATE
static java.lang.String	EVENT_SCREEN_OFF
static java.lang.String	EVENT_SCREEN_ON
static java.lang.String	EVENT_SCREEN_USER_PRESENT
static java.lang.String	TYPE The type of the event, could be "screen", "boot", "battery", or "ringer".
static java.lang.String	TYPE_BATTERY
static java.lang.String	TYPE_BOOT
static java.lang.String	TYPE_RINGER
static java.lang.String	TYPE_SCREEN

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

EOS, TIME_CREATED

Method Summary

Modifier and Type	Method and Description
static PStreamProvider	asUpdates() Provide a live stream of device events, including screen/boot/battery/ringer events.

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

TYPE

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

The type of the event, could be "screen", "boot", "battery", or "ringer".

See Also:

Constant Field Values

TYPE_SCREEN

public static final java.lang.String TYPE_SCREEN

See Also:

Constant Field Values

TYPE_BOOT

public static final java.lang.String TYPE_BOOT

See Also:

Constant Field Values

TYPE_BATTERY

public static final java.lang.String TYPE_BATTERY

See Also:

Constant Field Values

TYPE_RINGER

public static final java.lang.String TYPE_RINGER

See Also:

Constant Field Values

EVENT

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

The event name. For screen events, could be "on", "off", or "user_present"; For boot events, could be "boot_completed", or "shutdown"; For battery events, could be "low", "okay", "ac_connected", or "ac_disconnected"; For ringer events, could be "silent", "vibrate", or "normal".

See Also:

Constant Field Values

EVENT_SCREEN_OFF

public static final java.lang.String EVENT_SCREEN_OFF

See Also:

Constant Field Values

EVENT_SCREEN_USER_PRESENT

public static final java.lang.String EVENT_SCREEN_USER_PRESENT

See Also:

Constant Field Values

EVENT_SCREEN_ON

public static final java.lang.String EVENT_SCREEN_ON

See Also:

Constant Field Values

EVENT_BOOT_COMPLETED

public static final java.lang.String EVENT_BOOT_COMPLETED

See Also:

Constant Field Values

EVENT_BOOT_SHUTDOWN

public static final java.lang.String EVENT_BOOT_SHUTDOWN

See Also:

Constant Field Values

EVENT_BATTERY_LOW

public static final java.lang.String EVENT_BATTERY_LOW

See Also:

Constant Field Values

EVENT_BATTERY_OKAY

public static final java.lang.String EVENT_BATTERY_OKAY

See Also:

Constant Field Values

EVENT_BATTERY_AC_CONNECTED

public static final java.lang.String EVENT_BATTERY_AC_CONNECTED

See Also:

Constant Field Values

EVENT_BATTERY_AC_DISCONNECTED

public static final java.lang.String EVENT_BATTERY_AC_DISCONNECTED

See Also:

Constant Field Values

EVENT_RINGER_SILENT

public static final java.lang.String EVENT_RINGER_SILENT

See Also:

Constant Field Values

EVENT_RINGER_VIBRATE

public static final java.lang.String EVENT_RINGER_VIBRATE

See Also:

Constant Field Values

EVENT_RINGER_NORMAL

public static final java.lang.String EVENT_RINGER_NORMAL

See Also:

Constant Field Values

Method Detail

asUpdates

public static PStreamProvider asUpdates()

Provide a live stream of device events, including screen/boot/battery/ringer events.

Returns:

the provider function.