public final class ChatSession extends Chat implements java.lang.AutoCloseable
Implements a one-to-one chat session. They are described in 5.1. One-to-One Chat Sessions and XEP-0201: Best Practices for Message Threads.
In practice, instant messaging activity between human users tends to occur in the form of a conversational burst that we call a “chat session”: the exchange of multiple messages between two parties in relatively rapid succession within a relatively brief period of time.
In order to create a new chat session, use the chat manager.
Modifier and Type | Class and Description |
---|---|
static class |
ChatSession.ChatPartnerEvent
A
ChatPartnerEvent is fired, whenever a ChatSession ’s partner was replaced. |
Modifier and Type | Method and Description |
---|---|
void |
addChatPartnerListener(java.util.function.Consumer<ChatSession.ChatPartnerEvent> chatPartnerListener)
Adds a chat partner listener.
|
void |
close() |
Jid |
getChatPartner()
Gets the chat partner of this chat session.
|
java.lang.String |
getThread()
Gets the thread id which is used for this chat session.
|
void |
removeChatPartnerListener(java.util.function.Consumer<ChatSession.ChatPartnerEvent> chatPartnerListener)
Removes a chat partner listener.
|
SendTask<Message> |
sendMessage(Message message)
Sends a chat message to the chat partner.
|
SendTask<Message> |
sendMessage(java.lang.String message)
Sends a chat message to the chat partner.
|
addInboundMessageListener, removeInboundMessageListener
public final void addChatPartnerListener(java.util.function.Consumer<ChatSession.ChatPartnerEvent> chatPartnerListener)
Adds a chat partner listener.
chatPartnerListener
- The listener to add. Must not be null
.removeChatPartnerListener(Consumer)
,
ChatSession.ChatPartnerEvent
public final void removeChatPartnerListener(java.util.function.Consumer<ChatSession.ChatPartnerEvent> chatPartnerListener)
Removes a chat partner listener.
chatPartnerListener
- The listener to remove. Must not be null
.addChatPartnerListener(Consumer)
,
ChatSession.ChatPartnerEvent
public SendTask<Message> sendMessage(java.lang.String message)
Sends a chat message to the chat partner.
sendMessage
in class Chat
message
- The message.public SendTask<Message> sendMessage(Message message)
Sends a chat message to the chat partner.
sendMessage
in class Chat
message
- The message.public Jid getChatPartner()
Gets the chat partner of this chat session.
public java.lang.String getThread()
Gets the thread id which is used for this chat session.
public void close()
close
in interface java.lang.AutoCloseable
Copyright © 2014–2019 XMPP.rocks. All rights reserved.