info.guardianproject.panic

Class PanicTrigger

java.lang.Object

info.guardianproject.panic.PanicTrigger

public class PanicTrigger
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
PanicTrigger()

Method Summary

Modifier and Type	Method and Description
static boolean	addConnectedResponder(android.content.Context context, java.lang.String packageName) Add a packageName to the list of connected responders.
static boolean	checkForConnectIntent(android.app.Activity activity) Checks whether the provided Activity was started with the action Panic.ACTION_CONNECT, and if so, processes that Intent , adding the sending app as the panic trigger.
static boolean	checkForDisconnectIntent(android.app.Activity activity) Checks whether the provided Activity was started with the action Panic.ACTION_DISCONNECT, and if so, processes that Intent , removing the sending app as the panic trigger if it is currently configured to be so.
static boolean	disableResponder(android.content.Context context, java.lang.String packageName) Remove a packageName to the list of responders that will receive a trigger from this app.
static boolean	enableResponder(android.content.Context context, java.lang.String packageName) Add a packageName to the list of responders that will receive a trigger from this app.
static java.util.Set<java.lang.String>	getAllResponders(android.content.Context context) Get the Set of all packageNames of installed apps that include any Activity, BroadcastReceiver, or Service that responds to Panic.ACTION_TRIGGER Intents.
static java.util.Set<java.lang.String>	getConnectedResponders(android.content.Context context) Get the Set of packageNames of any Activitys or Services that respond to Panic.ACTION_TRIGGER and have been manually connected by the user to this app.
static java.util.Set<java.lang.String>	getEnabledResponders(android.content.Context context) Get the Set of packageNames of any Activitys or Services that respond to Panic.ACTION_TRIGGER and have been enabled by the user
static java.util.Set<java.lang.String>	getResponderActivities(android.content.Context context) Get the Set of packageNames of all Activitys that respond to Panic.ACTION_TRIGGER.
static java.util.Set<java.lang.String>	getResponderBroadcastReceivers(android.content.Context context) Get the Set of packageNames of all BroadcastReceivers that respond to Panic.ACTION_TRIGGER.
static java.util.Set<java.lang.String>	getResponderServices(android.content.Context context) Get the Set of packageNames of all Services that respond to Panic.ACTION_TRIGGER.
static java.util.Set<java.lang.String>	getRespondersThatCanConnect(android.content.Context context) Get all of the responders that are able to make a full connection using Panic.ACTION_CONNECT, which is used to configure the response an app makes.
static boolean	removeConnectedResponder(android.content.Context context, java.lang.String packageName) Remove a packageName from the list of connected responders.
static void	sendTrigger(android.content.Context context) Send a basic Panic.ACTION_TRIGGER Intent to all configured panic receivers.
static void	sendTrigger(android.content.Context context, android.content.Intent intent) Send the Intent to all configured panic receivers.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

PanicTrigger

public PanicTrigger()

Method Detail

checkForConnectIntent

public static boolean checkForConnectIntent(android.app.Activity activity)

Checks whether the provided Activity was started with the action Panic.ACTION_CONNECT, and if so, processes that Intent , adding the sending app as the panic trigger.

Parameters:

activity - the Activity to check for the Intent

Returns:

whether an ACTION_DISCONNECT Intent was received

checkForDisconnectIntent

public static boolean checkForDisconnectIntent(android.app.Activity activity)

Checks whether the provided Activity was started with the action Panic.ACTION_DISCONNECT, and if so, processes that Intent , removing the sending app as the panic trigger if it is currently configured to be so.

Parameters:

activity - the Activity to check for the Intent

Returns:

whether an ACTION_DISCONNECT Intent was received

addConnectedResponder

public static boolean addConnectedResponder(android.content.Context context,
                                            java.lang.String packageName)

Add a packageName to the list of connected responders.

Parameters:

context - the app's Context

packageName - the responder to add

Returns:

whether it was successfully completed

See Also:

removeConnectedResponder(Context, String)

removeConnectedResponder

public static boolean removeConnectedResponder(android.content.Context context,
                                               java.lang.String packageName)

Remove a packageName from the list of connected responders.

Parameters:

context - the app's Context

packageName - the responder to remove

Returns:

whether it was successfully removed

See Also:

addConnectedResponder(Context, String)

enableResponder

public static boolean enableResponder(android.content.Context context,
                                      java.lang.String packageName)

Add a packageName to the list of responders that will receive a trigger from this app.

Parameters:

context - the app's Context

packageName - the responder to add

Returns:

whether it was successfully completed

See Also:

disableResponder(Context, String)

disableResponder

public static boolean disableResponder(android.content.Context context,
                                       java.lang.String packageName)

Remove a packageName to the list of responders that will receive a trigger from this app.

Parameters:

context - the app's Context

packageName - the responder to add

Returns:

whether it was successfully completed

See Also:

enableResponder(Context, String)

getResponderActivities

public static java.util.Set<java.lang.String> getResponderActivities(android.content.Context context)

Get the Set of packageNames of all Activitys that respond to Panic.ACTION_TRIGGER.

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder Activitys

See Also:

to get the {@link android.app.Service}s, to get the {@link android.content.BroadcastReceiver}s

getResponderBroadcastReceivers

public static java.util.Set<java.lang.String> getResponderBroadcastReceivers(android.content.Context context)

Get the Set of packageNames of all BroadcastReceivers that respond to Panic.ACTION_TRIGGER. Unlike with Services and Activitys, a BroadcastReceiver cannot verify which app sent this Intent to it.

BroadcastReceivers are not able to verify which app sent this.

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder BroadcastReceivers

See Also:

to get the {@link Activity}s, to get the {@link android.app.Service}s

getResponderServices

public static java.util.Set<java.lang.String> getResponderServices(android.content.Context context)

Get the Set of packageNames of all Services that respond to Panic.ACTION_TRIGGER.

Services are not able to verify which app sent this.

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder Services

See Also:

to get the {@link Activity}s, to get the {@link android.content.BroadcastReceiver}s

getAllResponders

public static java.util.Set<java.lang.String> getAllResponders(android.content.Context context)

Get the Set of all packageNames of installed apps that include any Activity, BroadcastReceiver, or Service that responds to Panic.ACTION_TRIGGER Intents.

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder apps

See Also:

to get the {@link Activity}s, to get the {@link android.content.BroadcastReceiver}s, to get the {@link android.app.Service}s, getEnabledResponders(Context)

getConnectedResponders

public static java.util.Set<java.lang.String> getConnectedResponders(android.content.Context context)

Get the Set of packageNames of any Activitys or Services that respond to Panic.ACTION_TRIGGER and have been manually connected by the user to this app.

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder apps that are currently to this trigger app

See Also:

checkForConnectIntent(Activity), checkForDisconnectIntent(Activity), getAllResponders(Context), getEnabledResponders(Context)

getEnabledResponders

public static java.util.Set<java.lang.String> getEnabledResponders(android.content.Context context)

Get the Set of packageNames of any Activitys or Services that respond to Panic.ACTION_TRIGGER and have been enabled by the user

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder apps that are currently to this trigger app

See Also:

checkForConnectIntent(Activity), checkForDisconnectIntent(Activity), getAllResponders(Context), getConnectedResponders(Context)

getRespondersThatCanConnect

public static java.util.Set<java.lang.String> getRespondersThatCanConnect(android.content.Context context)

Get all of the responders that are able to make a full connection using Panic.ACTION_CONNECT, which is used to configure the response an app makes. For destructive responses, it is essential that the trigger and responder are connected in order to prevent random apps from making responders destroy things. Apps can also only respond to Panic.ACTION_TRIGGER with a non-destructive response which does not require the apps to connect or the user to configure anything.

Parameters:

context - the app's Context

Returns:

the set of packageNames of responder apps that can connect to a trigger app

sendTrigger

public static void sendTrigger(android.content.Context context)

Send a basic Panic.ACTION_TRIGGER Intent to all configured panic receivers. See sendTrigger(Context, Intent) if you want to use a custom Intent that can include things like a text message, email addresses, phone numbers, etc.

Only the receiving Activitys will be able to verify which app sent this, Services and BroadcastReceivers will not.

WARNING: If the receiving apps must be able to verify which app sent this Intent, then context must be an instance of Activity. Also, that Activity cannot have android:launchMode="singleInstance" (because it is not possible to get the calling Activity, as set by Activity.startActivityForResult(Intent, int, Bundle))

Parameters:

context - the Context that will send the trigger Intent, If this is an instance of Activity, then the receiving apps will be able to verify which app sent the Intent

Throws:

java.lang.IllegalArgumentException - if not a Panic.ACTION_TRIGGER Intent

sendTrigger

public static void sendTrigger(android.content.Context context,
                               android.content.Intent intent)

Send the Intent to all configured panic receivers. It must have an action of Panic.ACTION_TRIGGER or a IllegalArgumentException will be thrown. The Intent can include things like a text message, email addresses, phone numbers, etc. which a panic receiver app can use to send the message.

Only the receiving Activitys will be able to verify which app sent this, Services and BroadcastReceivers will not.

WARNING: If the receiving apps must be able to verify which app sent this Intent, then context must be an instance of Activity. Also, that Activity cannot have android:launchMode="singleInstance" (because it is not possible to get the calling Activity, as set by Activity.startActivityForResult(Intent, int, Bundle))

Parameters:

context - the Context that will send the trigger Intent, If this is an instance of Activity, then the receiving apps will be able to verify which app sent the Intent

intent - the Intent to send to panic responders

Throws:

java.lang.IllegalArgumentException - if not a Panic.ACTION_TRIGGER Intent