ChatSession (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.core.chat.Chat
- - rocks.xmpp.core.chat.ChatSession

```
public final class ChatSession
extends Chat
```
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.

5.1. One-to-One Chat Sessions

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChatSession.ChatPartnerEvent` A `ChatPartnerEvent` is fired, whenever a `ChatSession`'s partner was replaced.
`static interface`	`ChatSession.ChatPartnerListener` A listener interface which allows to listen for partner changes in chat sessions.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChatPartnerListener(ChatSession.ChatPartnerListener chatPartnerListener)` Adds a chat partner listener.
`Jid`	`getChatPartner()` Gets the chat partner of this chat session.
`String`	`getThread()` Gets the thread id which is used for this chat session.
`void`	`removeChatPartnerListener(ChatSession.ChatPartnerListener chatPartnerListener)` Removes a chat partner listener.
`void`	`send(Message message)` Deprecated. Use `sendMessage(Message)`
`void`	`send(String message)` Deprecated. Use `sendMessage(String)`
`Message`	`sendMessage(Message message)` Sends a chat message to the chat partner.
`Message`	`sendMessage(String message)` Sends a chat message to the chat partner.

Methods inherited from class rocks.xmpp.core.chat.Chat
addInboundMessageListener, removeInboundMessageListener

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addChatPartnerListener
```
public final void addChatPartnerListener(ChatSession.ChatPartnerListener chatPartnerListener)
```
    Adds a chat partner listener.
    
    Parameters:
    chatPartnerListener - The listener to add. Must not be null.
    Since:
    
    0.5.0
    
    See Also:
    removeChatPartnerListener(ChatPartnerListener), ChatSession.ChatPartnerListener, ChatSession.ChatPartnerEvent
  - removeChatPartnerListener
```
public final void removeChatPartnerListener(ChatSession.ChatPartnerListener chatPartnerListener)
```
    Removes a chat partner listener.
    
    Parameters:
    chatPartnerListener - The listener to remove. Must not be null.
    Since:
    
    0.5.0
    
    See Also:
    addChatPartnerListener(ChatPartnerListener), ChatSession.ChatPartnerListener, ChatSession.ChatPartnerEvent
  - send
```
@Deprecated
public void send(String message)
```
    Deprecated. Use sendMessage(String)
    
    Parameters:
    message - The message.
  - send
```
@Deprecated
public void send(Message message)
```
    Deprecated. Use sendMessage(Message)
    
    Parameters:
    message - The message.
  - sendMessage
```
public Message sendMessage(String message)
```
    Sends a chat message to the chat partner.
    
    Specified by:
    
    sendMessage in class Chat
    
    Parameters:
    message - The message.
    
    Returns:
    The message, which has been sent.
  - sendMessage
```
public Message sendMessage(Message message)
```
    Sends a chat message to the chat partner.
    
    Specified by:
    
    sendMessage in class Chat
    
    Parameters:
    message - The message.
    
    Returns:
    The message, which has been sent.
  - getChatPartner
```
public Jid getChatPartner()
```
    Gets the chat partner of this chat session.
    
    Returns:
    The chat partner.
  - getThread
```
public String getThread()
```
    Gets the thread id which is used for this chat session.
    
    Returns:
    The thread id.

Class ChatSession

Nested Class Summary

Method Summary

Methods inherited from class rocks.xmpp.core.chat.Chat

Methods inherited from class java.lang.Object

Method Detail

addChatPartnerListener

removeChatPartnerListener

send

send

sendMessage

sendMessage

getChatPartner

getThread