Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorslewis2007-05-20 16:27:08 -0400
committerslewis2007-05-20 16:27:08 -0400
commit8948fac07de90ad4ac4a2d1e412099fade72f7be (patch)
tree037a146e66c106ced33b82204a96cfc4583ca232 /framework/bundles/org.eclipse.ecf.presence
parentd76212391796fea2963c57158507ec1f296a49d2 (diff)
downloadorg.eclipse.ecf-8948fac07de90ad4ac4a2d1e412099fade72f7be.tar.gz
org.eclipse.ecf-8948fac07de90ad4ac4a2d1e412099fade72f7be.tar.xz
org.eclipse.ecf-8948fac07de90ad4ac4a2d1e412099fade72f7be.zip
Added simpler chat message in response to bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=187936
Diffstat (limited to 'framework/bundles/org.eclipse.ecf.presence')
-rw-r--r--framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/im/IChat.java46
1 files changed, 29 insertions, 17 deletions
diff --git a/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/im/IChat.java b/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/im/IChat.java
index 058ddd1f6..eb97fcb9e 100644
--- a/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/im/IChat.java
+++ b/framework/bundles/org.eclipse.ecf.presence/src/org/eclipse/ecf/presence/im/IChat.java
@@ -27,44 +27,55 @@ public interface IChat {
/**
* Get the receiver for this chat.
*
- * @return ID of receiver. Will not return <code>null</code>.
+ * @return ID of receiver. Will not return <code>null</code>.
*/
public ID getReceiverID();
/**
* Get the thread ID for this chat.
*
- * @return ID of this chat thread. Will not return <code>null</code>.
+ * @return ID of this chat thread. Will not return <code>null</code>.
*/
public ID getThreadID();
/**
- * Send chat message to given ID.
+ * Send chat message to receiver.
*
* @param type
- * the IChatMessage.Type of the message. May not be null.
+ * the IChatMessage.Type of the message. May not be
+ * <code>null</code>.
*
* @param subject
- * the subject of the message. May be null.
+ * the subject of the message. May be <code>null</code>.
*
- * @param body
- * the body of the message to send. May be null.
+ * @param messageBody
+ * the body of the message to send. May be <code>null</code>.
*
* @param properties
- * properties associated with message. May be null.
+ * any properties to be associated with message. May be
+ * <code>null</code>.
*
* @throws ECFException
- * thrown if toID is null, or currently disconnected
+ * thrown if currently disconnected or some transport error
*/
public void sendChatMessage(IChatMessage.Type type, String subject,
- String body, Map properties) throws ECFException;
+ String messageBody, Map properties) throws ECFException;
+
+ /**
+ * Send chat message to receiver.
+ *
+ * @param messageBody
+ * the body of the message to send. May be null.
+ * @throws ECFException
+ * thrown if currently disconnected or some transport error
+ */
+ public void sendChatMessage(String messageBody) throws ECFException;
-
/**
* Create a new IChatRoomContainer instance. This method can be used to
- * create to a chat room identified by this two-way chat. If supported
- * by the provider, this allows moving from a two-way chat represented
- * by this IChat instance to an n-way chat room container.
+ * create to a chat room identified by this two-way chat. If supported by
+ * the provider, this allows moving from a two-way chat represented by this
+ * IChat instance to an n-way chat room container.
*
* @return non-null IChatRoomContainer instance. Will not return
* <code>null</code>.
@@ -72,11 +83,12 @@ public interface IChat {
* if chat room container cannot be made.
*/
public IChatRoomContainer createChatRoom() throws ContainerCreateException;
-
+
/**
* Get presence container adapter for this chat instance.
- * @return IPresenceContainerAdapter for this chat instance. Will not
- * return <code>null</code>.
+ *
+ * @return IPresenceContainerAdapter for this chat instance. Will not return
+ * <code>null</code>.
*/
public IPresenceContainerAdapter getPresenceContainerAdapter();
}

Back to the top