|
Smack | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.smack.Chat
A chat is a series of messages sent between two users. Each chat has a unique ID, which is used to track which messages are part of the chat.
XMPPConnection.createChat(String)
Constructor Summary | |
Chat(XMPPConnection connection,
String participant)
Creates a new chat with the specified user. |
|
Chat(XMPPConnection connection,
String participant,
String chatID)
Creates a new chat with the specified user and chat ID (the XMPP "thread). |
Method Summary | |
void |
addMessageListener(PacketListener listener)
Adds a packet listener that will be notified of any new messages in the chat. |
Message |
createMessage()
Creates a new Message to the chat participant. |
String |
getChatID()
Returns the unique id of this chat, which corresponds to the thread field of XMPP messages. |
String |
getParticipant()
Returns the name of the user the chat is with. |
Message |
nextMessage()
Returns the next available message in the chat. |
Message |
nextMessage(long timeout)
Returns the next available message in the chat. |
Message |
pollMessage()
Polls for and returns the next message, or null if there isn't a message immediately available. |
void |
sendMessage(Message message)
Sends a message to the other chat participant. |
void |
sendMessage(String text)
Sends the specified text as a message to the other chat participant. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Chat(XMPPConnection connection, String participant)
connection
- the connection the chat will use.participant
- the user to chat with.public Chat(XMPPConnection connection, String participant, String chatID)
connection
- the connection the chat will use.participant
- the user to chat with.chatID
- the chat ID to use.Method Detail |
public String getChatID()
public String getParticipant()
public void sendMessage(String text) throws XMPPException
Message message = chat.createMessage(); message.setBody(messageText); chat.sendMessage(message);
text
- the text to send.
XMPPException
- if sending the message fails.public Message createMessage()
sendMessage(Message)
public void sendMessage(Message message) throws XMPPException
createMessage
method.
message
- the message to send.
XMPPException
- if an error occurs sending the message.public Message pollMessage()
nextMessage()
method since it's non-blocking.
In other words, the method call will always return immediately, whereas the
nextMessage method will return only when a message is available (or after
a specific timeout).
public Message nextMessage()
public Message nextMessage(long timeout)
timeout
- the maximum amount of time to wait for the next message.
public void addMessageListener(PacketListener listener)
listener
- a packet listener.
|
Smack | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |