org.linphone.core

Interface LinphoneChatRoom

public interface LinphoneChatRoom

A chat room is the place where text messages are exchanged. Can be created by linphone_core_create_chat_room().

Method Summary

Methods

Modifier and Type	Method and Description
void	compose() Notify the destination of the chat message being composed that the user is typing a new message.
LinphoneChatMessage	createFileTransferMessage(LinphoneContent content) Create a message attached to a dedicated chat room with a particular content.
LinphoneChatMessage	createLinphoneChatMessage(String message) Create a LinphoneChatMessage
LinphoneChatMessage	createLinphoneChatMessage(String message, String url, LinphoneChatMessage.State state, long timestamp, boolean isRead, boolean isIncoming) Create a LinphoneChatMessage
void	deleteHistory() Deletes all the messages associated with the peer of this chat room
void	deleteMessage(LinphoneChatMessage message) Deletes a message
LinphoneCall	getCall() get Curent Call associated to this chatroom if any To commit a message, use #linphone_chat_room_send_message
long	getChar() When realtime text is enabled LinphoneCallParams.realTimeTextEnabled, LinphoneCoreListener.isComposingReceived is call every time a char is received from peer.
LinphoneCore	getCore() Returns a back pointer to the core managing the chat room.
LinphoneChatMessage[]	getHistory() Returns the chat history associated with the peer address associated with this chat room
LinphoneChatMessage[]	getHistory(int limit) Returns the chat history associated with the peer address associated with this chat room
LinphoneChatMessage[]	getHistoryRange(int begin, int end) Returns the chat history associated with the peer address associated with this chat room for the given range, sorted from oldest to most recent
int	getHistorySize() Returns the amount of messages associated with the peer of this chatRoom.
LinphoneAddress	getPeerAddress() get peer address associated to this LinphoneChatRoom
int	getUnreadMessagesCount() Returns the amount of unread messages associated with the peer of this chatRoom.
boolean	isRemoteComposing() Tells whether the remote is currently composing a message.
void	markAsRead() Marks all the messages in this conversation as read
void	sendChatMessage(LinphoneChatMessage message)
void	sendMessage(LinphoneChatMessage message, LinphoneChatMessage.StateListener listener) Deprecated.
void	sendMessage(String message) send a message to peer member of this chat room.

Method Detail

getPeerAddress

LinphoneAddress getPeerAddress()

get peer address associated to this LinphoneChatRoom

Returns:

LinphoneAddress peer address

sendMessage

void sendMessage(String message)

send a message to peer member of this chat room.

Parameters:

message - to be sent

sendMessage

@Deprecated
void sendMessage(LinphoneChatMessage message,
                          LinphoneChatMessage.StateListener listener)

Deprecated.

Send a message to peer member of this chat room.

Parameters:

message - chat message

createLinphoneChatMessage

LinphoneChatMessage createLinphoneChatMessage(String message)

Create a LinphoneChatMessage

Parameters:

message - message to send

Returns:

LinphoneChatMessage object

getHistory

LinphoneChatMessage[] getHistory()

Returns the chat history associated with the peer address associated with this chat room

Returns:

an array of LinphoneChatMessage

getHistory

LinphoneChatMessage[] getHistory(int limit)

Returns the chat history associated with the peer address associated with this chat room

Parameters:

limit - the maximum number of messages to fetch

Returns:

an array of LinphoneChatMessage

getHistoryRange

LinphoneChatMessage[] getHistoryRange(int begin,
                                    int end)

Returns the chat history associated with the peer address associated with this chat room for the given range, sorted from oldest to most recent

Parameters:

begin - the first (most recent) message to retrieve. Newest message has index 0. If negative, use value 0 instead.

end - the last (oldest) message to retrieve. Oldest message has value "history size" - 1 (equivalent to -1). If negative or lower than begin value, value is given, use -1.

Returns:

an array of LinphoneChatMessage, empty if nothing has been found

getUnreadMessagesCount

int getUnreadMessagesCount()

Returns the amount of unread messages associated with the peer of this chatRoom.

Returns:

the amount of unread messages

getHistorySize

int getHistorySize()

Returns the amount of messages associated with the peer of this chatRoom.

Returns:

the amount of messages in the conversation

deleteHistory

void deleteHistory()

Deletes all the messages associated with the peer of this chat room

compose

void compose()

Notify the destination of the chat message being composed that the user is typing a new message.

isRemoteComposing

boolean isRemoteComposing()

Tells whether the remote is currently composing a message.

Returns:

true if the remote is currently composing a message, false otherwise.

markAsRead

void markAsRead()

Marks all the messages in this conversation as read

deleteMessage

void deleteMessage(LinphoneChatMessage message)

Deletes a message

Parameters:

message - the message to delete

createLinphoneChatMessage

LinphoneChatMessage createLinphoneChatMessage(String message,
                                            String url,
                                            LinphoneChatMessage.State state,
                                            long timestamp,
                                            boolean isRead,
                                            boolean isIncoming)

Create a LinphoneChatMessage

Returns:

LinphoneChatMessage object

getCore

LinphoneCore getCore()

Returns a back pointer to the core managing the chat room.

Returns:

the LinphoneCore

createFileTransferMessage

LinphoneChatMessage createFileTransferMessage(LinphoneContent content)

Create a message attached to a dedicated chat room with a particular content.

Parameters:

content - LinphoneContent initial content.

Returns:

a new LinphoneChatMessage

sendChatMessage

void sendChatMessage(LinphoneChatMessage message)

Parameters:

message -

getCall

LinphoneCall getCall()

get Curent Call associated to this chatroom if any To commit a message, use #linphone_chat_room_send_message

Returns:

LinphoneCall or NULL.

getChar

long getChar()

When realtime text is enabled LinphoneCallParams.realTimeTextEnabled, LinphoneCoreListener.isComposingReceived is call every time a char is received from peer. At the end of remote typing a regular LinphoneChatMessage is received with committed data from LinphoneCoreListener.messageReceived .

Returns:

RFC 4103/T.140 char