io.github.privacystreams.core

Class UQI

java.lang.Object

io.github.privacystreams.core.UQI

public class UQI
extends java.lang.Object

The unified query interface for all kinds of personal data. You will need to construct an UQI with `UQI uqi = new UQI(context);` To get a stream of personal data, simply call `uqi.getData` with a Stream provider.

Constructor Summary

Constructors

Constructor and Description
UQI(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	evaluate(Function<java.lang.Void,java.lang.Void> query, boolean retry) Evaluate current UQI.
android.content.Context	getContext()
PStream	getData(PStreamProvider pStreamProvider, Purpose purpose) Get a PStream from a provider with a purpose.
PSException	getException()
void	setContext(android.content.Context context)
void	stopAll() Stop all query in this UQI.

Methods inherited from class java.lang.Object

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

Constructor Detail

UQI

public UQI(android.content.Context context)

Method Detail

getContext

public android.content.Context getContext()

setContext

public void setContext(android.content.Context context)

getException

public PSException getException()

getData

public PStream getData(PStreamProvider pStreamProvider,
                       Purpose purpose)

Get a PStream from a provider with a purpose. For example, using `uqi.getData(Contact.getLogs(), Purpose.FEATURE("..."))` will return a stream of contacts.

Parameters:

pStreamProvider - the function to provide the personal data stream, e.g. Geolocation.asUpdates().

purpose - the purpose of personal data use, e.g. Purpose.ADS("xxx").

Returns:

a multi-item stream

stopAll

public void stopAll()

Stop all query in this UQI.

evaluate

public void evaluate(Function<java.lang.Void,java.lang.Void> query,
                     boolean retry)

Evaluate current UQI.

Parameters:

query - the query to evaluate.

retry - whether to try again if the permission is denied.