com.atakmap.android.ipc

Class AtakBroadcast

java.lang.Object

com.atakmap.android.ipc.AtakBroadcast

public final class AtakBroadcast
extends java.lang.Object

All use of Broadcasts within ATAK should utilize this class. If this class is not used within ATAK or the associated plugins, undefined actions could occur.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AtakBroadcast.DocumentedIntentFilter Instead of using IntentFilters, ATAK makes use of DocumentedIntentFilter to provide for automatic extraction of documentation supplied by the developer.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	dispose()
static AtakBroadcast	getInstance()
java.util.List<AtakBroadcast.DocumentedIntentFilter>	getLocalDocumentedFilters() Method still in progress
java.util.List<AtakBroadcast.DocumentedIntentFilter>	getSystemDocumentedFilters() Method still in progress
static void	init(android.content.Context context)
void	registerReceiver(android.content.BroadcastReceiver receiver, AtakBroadcast.DocumentedIntentFilter filter) Register a receive for any ATAK broadcasts that match the given DocumentedIntentFilter.
void	registerSystemReceiver(android.content.BroadcastReceiver receiver, AtakBroadcast.DocumentedIntentFilter filter) Register a system wide receiver.
boolean	sendBroadcast(android.content.Intent intent) Broadcast the given intent to all interested BroadcastReceivers.
void	sendIntents(java.util.List<android.content.Intent> intents) Method for iterating over an intent list and sending out the intents.
boolean	sendSystemBroadcast(android.content.Intent intent) Broadcast the given intent to all interested BroadcastReceivers (to include those outside of the system).
boolean	sendSystemBroadcast(android.content.Intent intent, java.lang.String permission) Broadcast the given intent to all interested BroadcastReceivers (to include those outside of the system).
void	unregisterReceiver(android.content.BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.
void	unregisterSystemReceiver(android.content.BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

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

Method Detail

init

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

getInstance

public static AtakBroadcast getInstance()

dispose

public void dispose()

registerReceiver

public void registerReceiver(android.content.BroadcastReceiver receiver,
                             AtakBroadcast.DocumentedIntentFilter filter)

Register a receive for any ATAK broadcasts that match the given DocumentedIntentFilter.

Parameters:

receiver - The BroadcastReceiver to handle the broadcast.

filter - Selects the Intent broadcasts to be received.

See Also:

unregisterReceiver(android.content.BroadcastReceiver)

registerSystemReceiver

public void registerSystemReceiver(android.content.BroadcastReceiver receiver,
                                   AtakBroadcast.DocumentedIntentFilter filter)

Register a system wide receiver. Do not use unless you are specifically looking for external intents. To unregister, use unregisterSystemReceiver. Do not use for intents local to ATAK or any of the plugins. Using this will flag your code in security reports.

Parameters:

receiver - The BroadcastReceiver to handle the broadcast.

filter - Selects the Intent broadcasts to be received.

See Also:

unregisterReceiver(android.content.BroadcastReceiver)

unregisterReceiver

public void unregisterReceiver(android.content.BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.

Parameters:

receiver - The BroadcastReceiver to unregister.

See Also:

registerReceiver(android.content.BroadcastReceiver, com.atakmap.android.ipc.AtakBroadcast.DocumentedIntentFilter)

unregisterSystemReceiver

public void unregisterSystemReceiver(android.content.BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed. Only use with receivers that were registered using registerSystemReceiver. For all others use unregisterReceiver(BroadcastReceiver).

Parameters:

receiver - The BroadcastReceiver to unregister.

See Also:

registerSystemReceiver(android.content.BroadcastReceiver, com.atakmap.android.ipc.AtakBroadcast.DocumentedIntentFilter)

sendBroadcast

public boolean sendBroadcast(android.content.Intent intent)

Broadcast the given intent to all interested BroadcastReceivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.

Parameters:

intent - The Intent to broadcast; all receivers matching this Intent will receive the broadcast.

See Also:

registerReceiver(android.content.BroadcastReceiver, com.atakmap.android.ipc.AtakBroadcast.DocumentedIntentFilter)

sendSystemBroadcast

public boolean sendSystemBroadcast(android.content.Intent intent)

Broadcast the given intent to all interested BroadcastReceivers (to include those outside of the system). This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. Unless required for external communication, use sendBroadcast(android.content.Intent)

Parameters:

intent - The Intent to broadcast; all receivers matching this Intent will receive the broadcast.

See Also:

registerSystemReceiver(android.content.BroadcastReceiver, com.atakmap.android.ipc.AtakBroadcast.DocumentedIntentFilter)

sendSystemBroadcast

public boolean sendSystemBroadcast(android.content.Intent intent,
                                   java.lang.String permission)

Broadcast the given intent to all interested BroadcastReceivers (to include those outside of the system). This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. Unless required for external communication, use sendBroadcast(android.content.Intent)

Parameters:

intent - The Intent to broadcast; all receivers matching this Intent will receive the broadcast.

permission - the permission to be used when sending a system broadcast

See Also:

registerSystemReceiver(android.content.BroadcastReceiver, com.atakmap.android.ipc.AtakBroadcast.DocumentedIntentFilter)

sendIntents

public void sendIntents(java.util.List<android.content.Intent> intents)

Method for iterating over an intent list and sending out the intents. Replaces IntentDispatchReceiver.

Parameters:

intents - list of intents to send

getLocalDocumentedFilters

public java.util.List<AtakBroadcast.DocumentedIntentFilter> getLocalDocumentedFilters()

Method still in progress

Returns:

returns all of the currently locally registered intent filters.

getSystemDocumentedFilters

public java.util.List<AtakBroadcast.DocumentedIntentFilter> getSystemDocumentedFilters()

Method still in progress

Returns:

returns all of the currently systemwide registered intent filters available.