com.atakmap.android.chat

Class ChatManagerMapComponent

java.lang.Object

com.atakmap.android.maps.AbstractMapComponent

com.atakmap.android.chat.ChatManagerMapComponent

All Implemented Interfaces:

MapComponent

public class ChatManagerMapComponent
extends AbstractMapComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ChatManagerMapComponent.ChatDropDownReceiver
static interface	ChatManagerMapComponent.ChatMessageListener
static class	ChatManagerMapComponent.MessageDestination

Nested classes/interfaces inherited from class com.atakmap.android.maps.AbstractMapComponent

AbstractMapComponent.OnAllComponentsCreatedCallback

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHAT_ROOM_DROPDOWN_CLOSED
static java.lang.String	NEW_CONTACT_MESSAGE
static java.lang.String	PLUGIN_SEND_MESSAGE_ALL_CHAT_ROOMS
static java.lang.String	PLUGIN_SEND_MESSAGE_EXTRA
static java.lang.String	REMOVE_MESSAGE
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
ChatManagerMapComponent()

Method Summary

Modifier and Type	Method and Description
void	addChatMessageListener(ChatManagerMapComponent.ChatMessageListener cml) Replacement for the intent currently in use for listenering to all chat messages incoming to the system.
android.os.Bundle	buildMessage(java.lang.String message, GroupContact group, java.lang.String[] destinations)
static IndividualContact	getChatBroadcastContact()
static GeoChatService	getChatService()
static ChatManagerMapComponent	getInstance()
static java.lang.String	getRoleName()
static java.lang.String	getTeamName()
static boolean	isSpecialGroup(java.lang.String id)
void	onChatConvoFragCreated(ConversationFragment frag)
void	onCreate(android.content.Context context, android.content.Intent intent, MapView view) Called when the component is first created
protected void	onDestroyImpl(android.content.Context context, MapView view) This method is invoked as a subset of the onDestroy call as part of the MapComponent lifecycle.
void	openConversation(IndividualContact contact, boolean editable) Given an individual contact, open the chat drop down for that contact.
void	openConversation(java.lang.String uid, boolean editable)
void	openConversation(java.lang.String title, java.lang.String uid, Contact[] contacts, boolean editable) Provides the ability to open a conversation as a drop down.
void	openConversation(java.lang.String conversationId, java.lang.String conversationName, java.lang.String targetUID, boolean editable, ChatManagerMapComponent.MessageDestination destination)
void	persistMessage(java.lang.String message, GroupContact group, java.util.List<java.lang.String> destinations)
void	registerChatMessageRenderer(ChatMesssageRenderer renderer) Set up a custom renderer for the chat line.
void	removeChatMessageListener(ChatManagerMapComponent.ChatMessageListener cml) Replacement for the intent currently in use for listenering to all chat messages incoming to the system.
boolean	sendMessage(android.os.Bundle msg, java.lang.String[] recipients)
void	sendMessage(java.lang.String msg) Given a message, prompt the user for a contact to send it to.
android.os.Bundle	sendMessage(java.lang.String message, GroupContact group, java.lang.String[] destinations, java.lang.String[] recipients)
void	sendMessage(java.lang.String msg, java.util.List<Contact> convos) Send a message to a list of different conversations

Methods inherited from class com.atakmap.android.maps.AbstractMapComponent

addOverlay, onConfigurationChanged, onCreateOptionsMenu, onDestroy, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPrepareOptionsMenu, onResume, onStart, onStop, registerReceiver, removeOverlay, setOnAllComponentsCreatedCallback, unregisterReceiver

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

REMOVE_MESSAGE

public static java.lang.String REMOVE_MESSAGE

NEW_CONTACT_MESSAGE

public static java.lang.String NEW_CONTACT_MESSAGE

PLUGIN_SEND_MESSAGE_ALL_CHAT_ROOMS

public static final java.lang.String PLUGIN_SEND_MESSAGE_ALL_CHAT_ROOMS

See Also:

Constant Field Values

PLUGIN_SEND_MESSAGE_EXTRA

public static final java.lang.String PLUGIN_SEND_MESSAGE_EXTRA

See Also:

Constant Field Values

CHAT_ROOM_DROPDOWN_CLOSED

public static java.lang.String CHAT_ROOM_DROPDOWN_CLOSED

Constructor Detail

ChatManagerMapComponent

public ChatManagerMapComponent()

Method Detail

getChatBroadcastContact

public static IndividualContact getChatBroadcastContact()

getInstance

public static ChatManagerMapComponent getInstance()

getTeamName

public static java.lang.String getTeamName()

getRoleName

public static java.lang.String getRoleName()

sendMessage

public void sendMessage(java.lang.String msg,
                        java.util.List<Contact> convos)

Send a message to a list of different conversations

Parameters:

msg - Plain-text message to send

convos - List of conversations to send the message to Note: This is not necessarily the list of destination contacts (i.e. groups -> group members)

sendMessage

public void sendMessage(java.lang.String msg)

Given a message, prompt the user for a contact to send it to. Shortcut for sendMessage(msg, null).

Parameters:

msg - the message to send

openConversation

public void openConversation(java.lang.String conversationId,
                             java.lang.String conversationName,
                             java.lang.String targetUID,
                             boolean editable,
                             ChatManagerMapComponent.MessageDestination destination)

isSpecialGroup

public static boolean isSpecialGroup(java.lang.String id)

openConversation

public void openConversation(IndividualContact contact,
                             boolean editable)

Given an individual contact, open the chat drop down for that contact.

Parameters:

contact - the individual contact

editable - boolean if the user can use this drop down to chat or just view the current chat.

openConversation

public void openConversation(java.lang.String title,
                             java.lang.String uid,
                             Contact[] contacts,
                             boolean editable)

Provides the ability to open a conversation as a drop down.

Parameters:

title - the title to provide the drop down

uid - the uid of the conversation

contacts - the contaxct list that is used to describe the conversation

editable - if the user is allowed to send new chat in this opened drop down.

openConversation

public void openConversation(java.lang.String uid,
                             boolean editable)

persistMessage

public void persistMessage(java.lang.String message,
                           GroupContact group,
                           java.util.List<java.lang.String> destinations)

sendMessage

public android.os.Bundle sendMessage(java.lang.String message,
                                     GroupContact group,
                                     java.lang.String[] destinations,
                                     java.lang.String[] recipients)

sendMessage

public boolean sendMessage(android.os.Bundle msg,
                           java.lang.String[] recipients)

buildMessage

public android.os.Bundle buildMessage(java.lang.String message,
                                      GroupContact group,
                                      java.lang.String[] destinations)

onCreate

public void onCreate(android.content.Context context,
                     android.content.Intent intent,
                     MapView view)

Description copied from interface: MapComponent

Called when the component is first created

Specified by:

onCreate in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

intent - the intent of the MapActivity

view - the main MapView

getChatService

public static GeoChatService getChatService()

onDestroyImpl

protected void onDestroyImpl(android.content.Context context,
                             MapView view)

Description copied from class: AbstractMapComponent

This method is invoked as a subset of the onDestroy call as part of the MapComponent lifecycle.

Specified by:

onDestroyImpl in class AbstractMapComponent

onChatConvoFragCreated

public void onChatConvoFragCreated(ConversationFragment frag)

registerChatMessageRenderer

public void registerChatMessageRenderer(ChatMesssageRenderer renderer)

Set up a custom renderer for the chat line.

Parameters:

renderer - the custom renderer or null if no renderer should be used.

addChatMessageListener

public void addChatMessageListener(ChatManagerMapComponent.ChatMessageListener cml)

Replacement for the intent currently in use for listenering to all chat messages incoming to the system. Adds a chat message listener to be notified. Please note that the intent "com.atakmap.android.ChatMessagePopups.NEW_CHAT_RECEIVED" will be deprecated as of 4.8

Parameters:

cml - the chat message listener that is to be notified.

removeChatMessageListener

public void removeChatMessageListener(ChatManagerMapComponent.ChatMessageListener cml)

Replacement for the intent currently in use for listenering to all chat messages incoming to the system. Removes a chat message listener to be notified. Please note that the intent "com.atakmap.android.ChatMessagePopups.NEW_CHAT_RECEIVED" will be deprecated as of 4.8

Parameters:

cml - the chat message listener that is to be notified.