io.github.privacystreams.communication

Class Message

java.lang.Object

io.github.privacystreams.core.Item

io.github.privacystreams.communication.Message

@PSItem
public class Message
extends Item

A text message. It could be from SMS, WhatsApp, Facebook, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTACT The contact (phone number or name) of the message.
static java.lang.String	CONTENT The message content.
static java.lang.String	PACKAGE_NAME The package name of the app where message is captured.
static java.lang.String	TIMESTAMP The timestamp of when the message is sent or received.
static java.lang.String	TYPE The message type, could be "received", "sent", "draft", "pending", or "unknown".
static java.lang.String	TYPE_DRAFT
static java.lang.String	TYPE_PENDING
static java.lang.String	TYPE_RECEIVED
static java.lang.String	TYPE_SENT
static java.lang.String	TYPE_UNKNOWN

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

EOS, TIME_CREATED

Method Summary

Modifier and Type	Method and Description
static PStreamProvider	asIncomingSMS() Provide a live stream of new incoming Message items from the Android Short Message Service (SMS).
static PStreamProvider	asUpdatesInIM() Provide a live stream of new Message items in Instant Messenger (IM) apps, including WhatsApp and Facebook.
static PStreamProvider	getAllSMS() Provide all Message items from Android Short Message Service SMS.

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

CONTENT

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

The message content.

See Also:

Constant Field Values

PACKAGE_NAME

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

The package name of the app where message is captured. For example, if it is a Facebook message, package_name will be "com.facebook.orca"; If it is an SMS message, package_name will be "system".

See Also:

Constant Field Values

CONTACT

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

The contact (phone number or name) of the message.

See Also:

Constant Field Values

TIMESTAMP

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

The timestamp of when the message is sent or received.

See Also:

Constant Field Values

TYPE

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

The message type, could be "received", "sent", "draft", "pending", or "unknown".

See Also:

Constant Field Values

TYPE_RECEIVED

public static final java.lang.String TYPE_RECEIVED

See Also:

Constant Field Values

TYPE_SENT

public static final java.lang.String TYPE_SENT

See Also:

Constant Field Values

TYPE_DRAFT

public static final java.lang.String TYPE_DRAFT

See Also:

Constant Field Values

TYPE_PENDING

public static final java.lang.String TYPE_PENDING

See Also:

Constant Field Values

TYPE_UNKNOWN

public static final java.lang.String TYPE_UNKNOWN

See Also:

Constant Field Values

Method Detail

asUpdatesInIM

public static PStreamProvider asUpdatesInIM()

Provide a live stream of new Message items in Instant Messenger (IM) apps, including WhatsApp and Facebook. This provider requires Accessibility service turned on.

Returns:

the provider function

asIncomingSMS

public static PStreamProvider asIncomingSMS()

Provide a live stream of new incoming Message items from the Android Short Message Service (SMS). This provider requires `android.permission.RECEIVE_SMS` permission.

Returns:

the provider

getAllSMS

public static PStreamProvider getAllSMS()

Provide all Message items from Android Short Message Service SMS. This provider requires `android.permission.READ_SMS` permission.

Returns:

the provider