com.atakmap.android.missionpackage.api

Class MissionPackageApi

java.lang.Object

com.atakmap.android.missionpackage.api.MissionPackageApi

public class MissionPackageApi
extends java.lang.Object

Mission Package Intent API interface to 'Save' or 'Save & Send' a Mission Package Provides mechanisms which allow other tools in ATAK to get callback after the Mission Package has been created (on sending device), sent (on sending device), and extracted (on receiving device).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INTENT_EXTRA_MISSIONPACKAGEMANIFEST MissionPackage Extra [Required] Type: MissionPackageManifest An instance of MissionPackageManifest which contains files and/or ATAK Map Items to include in the Mission Package.
static java.lang.String	INTENT_EXTRA_MISSIONPACKAGEMANIFEST_UID
static java.lang.String	INTENT_EXTRA_NOTIFICATION_ID NotificationId Extra Type: int See FileTransfer extra
static java.lang.String	INTENT_EXTRA_PATH
static java.lang.String	INTENT_EXTRA_RECEIVERS Receivers Extra [Optional] Type: NetworkContact Parcelable Array.
static java.lang.String	INTENT_EXTRA_SAVEANDSEND SaveAndSend Extra [Optional] Type: boolean Omit or false to save only.
static java.lang.String	INTENT_EXTRA_SENDERCALLBACKCLASSNAME SenderCallbackClassName Extra [Optional] Type: String Name of class to invoke when save is complete and when Contact List has been launched.
static java.lang.String	INTENT_EXTRA_SENDERCALLBACKPACKAGENAME SenderCallbackClassName Extra [Optional] Type: String Name of class to invoke when save is complete and when Contact List has been launched.
static java.lang.String	INTENT_EXTRA_SENDERCALLSIGN Sender Callsign Extra Type: String A custom intent may sent on the receiving device once the Mission Package has been extracted.
static java.lang.String	INTENT_EXTRA_SENDONLY SaveOnly Extra [Optional}: boolean Omit or false to save prior to sending.
static java.lang.String	INTENT_MISSIONPACKAGE_DELETE Action for intent to delete an existing Mission Package
static java.lang.String	INTENT_MISSIONPACKAGE_SAVE Action for intent to save a new Mission Package
static java.lang.String	INTENT_MISSIONPACKAGE_UPDATE Action for intent to update an existing Mission Package

Constructor Summary

Constructors

Constructor and Description
MissionPackageApi()

Method Summary

Modifier and Type	Method and Description
static MissionPackageManifest	CreateTempManifest(java.lang.String name) Create a manifest such that zip will be created in a temp directory This directory is periodically cleaned out (contents securely deleted) Use default import instructions
static MissionPackageManifest	CreateTempManifest(java.lang.String name, boolean bImport, boolean bDelete, java.lang.String onReceiveAction) Create a manifest such that zip will be created in a temp directory This directory is periodically cleaned out (contents securely deleted) Set import instructions
static boolean	Delete(android.content.Context context, MissionPackageManifest manifest) Send an intent to Delete the specified Mission Package
static boolean	prepareSend(MissionPackageManifest manifest, java.lang.Class<? extends SaveAndSendCallback> callbackClazz, boolean sendOnly) Brings up the contacts list BEFORE posting to the server
static boolean	Save(android.content.Context context, MissionPackageManifest manifest, java.lang.Class<? extends SaveAndSendCallback> callbackClazz) Send an intent to Save the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip
static boolean	Send(android.content.Context context, MissionPackageManifest manifest, java.lang.Class<? extends SaveAndSendCallback> callbackClazz, Contact[] netContacts) Send an intent to Save and Send the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip and then sent to the specified contacts.
static boolean	Send(android.content.Context context, MissionPackageManifest manifest, java.lang.Class<? extends SaveAndSendCallback> callbackClazz, Contact[] netContacts, boolean sendOnly) Send an intent to Save and Send the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip and then sent to the specified contacts.
static boolean	Send(java.io.File file) Quick send of file as a Mission Package, display contact list to select recipients Package is auto deleted on sender and recipient
static boolean	Send(java.io.File file, java.lang.String title) Quick send of file as a Mission Package, display contact list to select recipients Package is auto deleted on sender and recipient
static boolean	SendUIDs(android.content.Context context, MissionPackageManifest manifest, java.lang.Class<? extends SaveAndSendCallback> callbackClazz, java.lang.String[] toUIDs, boolean sendOnly)
static boolean	SendUIDs(android.content.Context context, MissionPackageManifest manifest, java.lang.String callbackClassName, java.lang.String[] toUIDs, boolean sendOnly) Send an intent to Save and Send the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip and then sent to the specified contacts.
static boolean	Update(android.content.Context context, java.lang.String missionPackageUID, java.lang.String[] mapItemUIDArray, java.lang.String[] files, boolean bSave, java.lang.Class<? extends SaveAndSendCallback> callbackClazz) Send an intent to Update the specified Mission Package by adding the specified map items and files.

Methods inherited from class java.lang.Object

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

Field Detail

INTENT_MISSIONPACKAGE_SAVE

public static final java.lang.String INTENT_MISSIONPACKAGE_SAVE

Action for intent to save a new Mission Package

See Also:

Constant Field Values

INTENT_MISSIONPACKAGE_UPDATE

public static final java.lang.String INTENT_MISSIONPACKAGE_UPDATE

Action for intent to update an existing Mission Package

See Also:

Constant Field Values

INTENT_MISSIONPACKAGE_DELETE

public static final java.lang.String INTENT_MISSIONPACKAGE_DELETE

Action for intent to delete an existing Mission Package

See Also:

Constant Field Values

INTENT_EXTRA_MISSIONPACKAGEMANIFEST

public static final java.lang.String INTENT_EXTRA_MISSIONPACKAGEMANIFEST

MissionPackage Extra [Required] Type: MissionPackageManifest An instance of MissionPackageManifest which contains files and/or ATAK Map Items to include in the Mission Package. Note, if you want Mission Package Tool to import the Mission Package, then the "path" must be set to the "ATAK/datapackage" directory on a supported mounted file system

See Also:

Constant Field Values

INTENT_EXTRA_MISSIONPACKAGEMANIFEST_UID

public static final java.lang.String INTENT_EXTRA_MISSIONPACKAGEMANIFEST_UID

See Also:

Constant Field Values

INTENT_EXTRA_PATH

public static final java.lang.String INTENT_EXTRA_PATH

See Also:

Constant Field Values

INTENT_EXTRA_SAVEANDSEND

public static final java.lang.String INTENT_EXTRA_SAVEANDSEND

SaveAndSend Extra [Optional] Type: boolean Omit or false to save only. True to save and then send either to an explicit list of receivers, or to receivers selected via Contact List

See Also:

Constant Field Values

INTENT_EXTRA_SENDONLY

public static final java.lang.String INTENT_EXTRA_SENDONLY

SaveOnly Extra [Optional}: boolean Omit or false to save prior to sending. True to skip saving/compression and just send the package

See Also:

Constant Field Values

INTENT_EXTRA_SENDERCALLBACKCLASSNAME

public static final java.lang.String INTENT_EXTRA_SENDERCALLBACKCLASSNAME

SenderCallbackClassName Extra [Optional] Type: String Name of class to invoke when save is complete and when Contact List has been launched. Must implement SaveAndSendCallback as reflection is used to instantiate the class via a parameterless constructor. Note the callback will be invoked once compression (save) is complete, and again once the Contact List has been launched. The callback may check the type of the provided task to determine which step has completed, and may obtain the Context or ATAK MapView from the task. If a callback needs access to the "local" tool which is being integrated the code may access a singleton provided by the tool implementation, or provide an alternative method to get a reference to required resources. Note that use of Proguard and inline classes may prohibit the execution of the required parameter-less constructor via Reflection in the callback class.

See Also:

Constant Field Values

INTENT_EXTRA_SENDERCALLBACKPACKAGENAME

public static final java.lang.String INTENT_EXTRA_SENDERCALLBACKPACKAGENAME

SenderCallbackClassName Extra [Optional] Type: String Name of class to invoke when save is complete and when Contact List has been launched. Must implement SaveAndSendCallback as reflection is used to instantiate the class via a parameterless constructor.

See Also:

Constant Field Values

INTENT_EXTRA_RECEIVERS

public static final java.lang.String INTENT_EXTRA_RECEIVERS

Receivers Extra [Optional] Type: NetworkContact Parcelable Array. Omit to use Contact List to select receivers. Provide array of NetworkContacts to send to specific users. Only processed if SaveAndSend is true

See Also:

Constant Field Values

INTENT_EXTRA_SENDERCALLSIGN

public static final java.lang.String INTENT_EXTRA_SENDERCALLSIGN

Sender Callsign Extra Type: String A custom intent may sent on the receiving device once the Mission Package has been extracted. See ReceiveParams extra. If so, this extra as well as MissionPackage and the ID of the user notification are included in the custom intent that is generated on the receiving device. This intent is not required or supported for intent MISSIONPACKAGE_SAVE. See MissionPackageConfiguration.PARAMETER_OnReceiveAction

See Also:

Constant Field Values

INTENT_EXTRA_NOTIFICATION_ID

public static final java.lang.String INTENT_EXTRA_NOTIFICATION_ID

NotificationId Extra Type: int See FileTransfer extra

See Also:

Constant Field Values

Constructor Detail

MissionPackageApi

public MissionPackageApi()

Method Detail

Save

public static boolean Save(android.content.Context context,
                           MissionPackageManifest manifest,
                           java.lang.Class<? extends SaveAndSendCallback> callbackClazz)

Send an intent to Save the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip

Parameters:

context - [required]

manifest - [required]

callbackClazz - [optional]

Returns:

true if intent was successfully populated and broadcast

Send

public static boolean Send(android.content.Context context,
                           MissionPackageManifest manifest,
                           java.lang.Class<? extends SaveAndSendCallback> callbackClazz,
                           Contact[] netContacts)

Send an intent to Save and Send the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip and then sent to the specified contacts. If none are provided, then the ATAK Contact List will be launched for the user to select the receivers

Parameters:

context - [required]

manifest - [required]

callbackClazz - [optional]

netContacts - [optional]

Returns:

true if intent was successfully populated and broadcast

Send

public static boolean Send(android.content.Context context,
                           MissionPackageManifest manifest,
                           java.lang.Class<? extends SaveAndSendCallback> callbackClazz,
                           Contact[] netContacts,
                           boolean sendOnly)

Send an intent to Save and Send the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip and then sent to the specified contacts. If none are provided, then the ATAK Contact List will be launched for the user to select the receivers

Parameters:

context - [required]

manifest - [required]

callbackClazz - [optional]

netContacts - [optional]

sendOnly - if true, skip saving/compression, and just send an existing package

Returns:

true if intent was successfully populated and broadcast

Send

public static boolean Send(java.io.File file)

Quick send of file as a Mission Package, display contact list to select recipients Package is auto deleted on sender and recipient

Parameters:

file - file to send [required]

Returns:

true if the file was sent

Send

public static boolean Send(java.io.File file,
                           java.lang.String title)

Quick send of file as a Mission Package, display contact list to select recipients Package is auto deleted on sender and recipient

Parameters:

file - file to send [required]

title - title of mission package[required]

Returns:

true if the file was sent

SendUIDs

public static boolean SendUIDs(android.content.Context context,
                               MissionPackageManifest manifest,
                               java.lang.String callbackClassName,
                               java.lang.String[] toUIDs,
                               boolean sendOnly)

Send an intent to Save and Send the specified Mission Package with the provided parameters The specified contents will be compressed into Mission Package .zip and then sent to the specified contacts. If none are provided, then the ATAK Contact List will be launched for the user to select the receivers

Parameters:

context - [required]

manifest - [required]

callbackClassName - [optional]

toUIDs - [optional]

sendOnly - if true, skip saving/compression, and just send an existing package

Returns:

true if intent was successfully populated and broadcast

SendUIDs

public static boolean SendUIDs(android.content.Context context,
                               MissionPackageManifest manifest,
                               java.lang.Class<? extends SaveAndSendCallback> callbackClazz,
                               java.lang.String[] toUIDs,
                               boolean sendOnly)

prepareSend

public static boolean prepareSend(MissionPackageManifest manifest,
                                  java.lang.Class<? extends SaveAndSendCallback> callbackClazz,
                                  boolean sendOnly)

Brings up the contacts list BEFORE posting to the server

Parameters:

manifest - Mission package manifest

callbackClazz - Callback class

sendOnly - True to only send, false to compress before sending

Update

public static boolean Update(android.content.Context context,
                             java.lang.String missionPackageUID,
                             java.lang.String[] mapItemUIDArray,
                             java.lang.String[] files,
                             boolean bSave,
                             java.lang.Class<? extends SaveAndSendCallback> callbackClazz)

Send an intent to Update the specified Mission Package by adding the specified map items and files. At least one item or file is required. Files attached to specified map items will be included in the package.

Parameters:

context - [required]

missionPackageUID - [required] UID of package to update

mapItemUIDArray - [optional]

files - [optional]

bSave - true to save, false to just add to UI list

callbackClazz - [optional]

Returns:

true if the package was updated.

Delete

public static boolean Delete(android.content.Context context,
                             MissionPackageManifest manifest)

Send an intent to Delete the specified Mission Package

Parameters:

context - [required]

manifest - [required] package to delete

Returns:

a boolean if delete was successful.

CreateTempManifest

public static MissionPackageManifest CreateTempManifest(java.lang.String name)

Create a manifest such that zip will be created in a temp directory This directory is periodically cleaned out (contents securely deleted) Use default import instructions

Parameters:

name - the name of the manifest

Returns:

the MissionPackageManifest object that represents the manifest file.

CreateTempManifest

public static MissionPackageManifest CreateTempManifest(java.lang.String name,
                                                        boolean bImport,
                                                        boolean bDelete,
                                                        java.lang.String onReceiveAction)

Create a manifest such that zip will be created in a temp directory This directory is periodically cleaned out (contents securely deleted) Set import instructions

Parameters:

name - name of package

bImport - true to run extracted files against Import Manager

bDelete - true to delete .zip after extraction

onReceiveAction - Intent action to broadcast on receiver after extraction/deletion

Returns: