blob: 5b76cd8abffbb50154e55be7e7fe025d3de96ce4 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/****************************************************************************
* Copyright (c) 2007 Composent, Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Composent, Inc. - initial API and implementation
*****************************************************************************/
package org.eclipse.ecf.presence.im;
import java.util.Map;
import org.eclipse.ecf.core.ContainerCreateException;
import org.eclipse.ecf.core.identity.ID;
import org.eclipse.ecf.core.util.ECFException;
import org.eclipse.ecf.presence.IPresenceContainerAdapter;
import org.eclipse.ecf.presence.chatroom.IChatRoomContainer;
/**
* Object representing a specific two-way chat.
*/
public interface IChat {
/**
* Get the receiver for this chat.
*
* @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>.
*/
public ID getThreadID();
/**
* Send chat message to receiver.
*
* @param type
* the IChatMessage.Type of the message. May not be
* <code>null</code>.
*
* @param subject
* the subject of the message. May be <code>null</code>.
*
* @param messageBody
* the body of the message to send. May be <code>null</code>.
*
* @param properties
* any properties to be associated with message. May be
* <code>null</code>.
*
* @throws ECFException
* thrown if currently disconnected or some transport error
*/
public void sendChatMessage(IChatMessage.Type type, String subject,
String messageBody, Map properties) throws ECFException;
/**
* Send chat message to receiver.
*
* @param messageBody
* the body of the message to send. May be <code>null</code>.
* @throws ECFException
* thrown if currently disconnected or some transport error
*/
public void sendChatMessage(String messageBody) throws ECFException;
/**
* Get typing message sender. If sending typing messages not supported by
* this provider then <code>null</code> will be returned.
*
* @return ITypingMessageSender to use for sending typing messages
* (instances of ITypingMessage). If <code>null</code>, sending
* typing messages not supported by this provider.
*/
public ITypingMessageSender getTypingMessageSender();
/**
* 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.
*
* @return non-null IChatRoomContainer instance. Will not return
* <code>null</code>.
* @throws ContainerCreateException
* 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>.
*/
public IPresenceContainerAdapter getPresenceContainerAdapter();
}
|
