public interface ChatRoom
Modifier and Type | Interface and Description |
---|---|
static class |
ChatRoom.State |
Modifier and Type | Method and Description |
---|---|
void |
addCompatibleParticipants(Address deviceAddr,
Address[] participantsCompatible)
Set the participant device.
|
void |
addListener(ChatRoomListener listener) |
void |
addParticipant(Address addr)
Add a participant to a chat room.
|
void |
addParticipantDevice(Address participantAddress,
Address deviceAddress)
Add a participant device.
|
void |
addParticipants(Address[] addresses)
Add several participants to a chat room at once.
|
boolean |
canHandleParticipants()
Tells whether a chat room is able to handle participants.
|
void |
compose()
Notifies the destination of the chat message being composed that the user is
typing a new message.
|
ChatMessage |
createFileTransferMessage(Content initialContent)
Create a message attached to a dedicated chat room with a particular content.
|
ChatMessage |
createMessage(java.lang.String message)
Create a message attached to a dedicated chat room;.
|
void |
deleteHistory()
Delete all messages from the history.
|
void |
deleteMessage(ChatMessage msg)
Delete a message from the chat room history.
|
ChatMessage |
findMessage(java.lang.String messageId)
Gets the chat message sent or received in this chat room that matches the
message_id.
|
Participant |
findParticipant(Address addr)
Find a participant of a chat room from its address.
|
Call |
getCall()
get Curent Call associated to this chatroom if any To commit a message, use
linphone_chat_room_send_message
|
int |
getCapabilities()
Get the capabilities of a chat room.
|
int |
getChar()
When realtime text is enabled linphone_call_params_realtime_text_enabled,
LinphoneCoreIsComposingReceivedCb is call everytime a char is received from
peer.
|
Address[] |
getComposingAddresses()
Gets the list of participants that are currently composing.
|
Address |
getConferenceAddress()
Get the conference address of the chat room.
|
Core |
getCore()
Returns back pointer to #LinphoneCore object.
|
ChatMessage[] |
getHistory(int nbMessage)
Gets nb_message most recent messages from cr chat room, sorted from oldest to
most recent.
|
EventLog[] |
getHistoryEvents(int nbEvents)
Gets nb_events most recent events from cr chat room, sorted from oldest to most
recent.
|
int |
getHistoryEventsSize()
Gets the number of events in a chat room.
|
EventLog[] |
getHistoryMessageEvents(int nbEvents)
Gets nb_events most recent chat message events from cr chat room, sorted from
oldest to most recent.
|
ChatMessage[] |
getHistoryRange(int begin,
int end)
Gets the partial list of messages in the given range, sorted from oldest to
most recent.
|
EventLog[] |
getHistoryRangeEvents(int begin,
int end)
Gets the partial list of events in the given range, sorted from oldest to most
recent.
|
EventLog[] |
getHistoryRangeMessageEvents(int begin,
int end)
Gets the partial list of chat message events in the given range, sorted from
oldest to most recent.
|
int |
getHistorySize()
Gets the number of messages in a chat room.
|
ChatMessage |
getLastMessageInHistory()
Gets the last chat message sent or received in this chat room.
|
long |
getLastUpdateTime()
Return the last updated time for the chat room.
|
Address |
getLocalAddress()
get local address associated to this #LinphoneChatRoom
|
Participant |
getMe()
Get the participant representing myself in the chat room.
|
int |
getNbParticipants()
Get the number of participants in the chat room (that is without ourselves).
|
Participant[] |
getParticipants()
Get the list of participants of a chat room.
|
Address |
getPeerAddress()
get peer address associated to this #LinphoneChatRoom
|
ChatRoom.State |
getState()
Get the state of the chat room.
|
java.lang.String |
getSubject()
Get the subject of a chat room.
|
int |
getUnreadMessagesCount()
Gets the number of unread messages in the chatroom.
|
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
boolean |
hasBeenLeft()
Return whether or not the chat room has been left.
|
boolean |
hasCapability(int mask)
Check if a chat room has given capabilities.
|
boolean |
isRemoteComposing()
Tells whether the remote is currently composing a message.
|
void |
leave()
Leave a chat room.
|
boolean |
limeAvailable()
Returns true if lime is available for given peer.
|
void |
markAsRead()
Mark all messages of the conversation as read.
|
void |
receiveChatMessage(ChatMessage msg)
Used to receive a chat message when using async mechanism with IM encryption
engine.
|
void |
removeListener(ChatRoomListener listener) |
void |
removeParticipant(Participant participant)
Remove a participant of a chat room.
|
void |
removeParticipants(Participant[] participants)
Remove several participants of a chat room at once.
|
void |
sendChatMessage(ChatMessage msg)
Send a message to peer member of this chat room.
|
void |
setConferenceAddress(Address confAddr)
Set the conference address of a group chat room.
|
void |
setParticipantAdminStatus(Participant participant,
boolean isAdmin)
Change the admin status of a participant of a chat room (you need to be an
admin yourself to do this).
|
void |
setParticipantDevices(Address partAddr,
Address[] partDevices)
Set the participant device.
|
void |
setSubject(java.lang.String subject)
Set the subject of a chat room.
|
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
Call getCall()
int getCapabilities()
int getChar()
Address[] getComposingAddresses()
Address getConferenceAddress()
void setConferenceAddress(Address confAddr)
Core getCore()
int getHistoryEventsSize()
int getHistorySize()
boolean isRemoteComposing()
ChatMessage getLastMessageInHistory()
long getLastUpdateTime()
Address getLocalAddress()
Participant getMe()
int getNbParticipants()
Participant[] getParticipants()
Address getPeerAddress()
ChatRoom.State getState()
java.lang.String getSubject()
void setSubject(java.lang.String subject)
int getUnreadMessagesCount()
void addCompatibleParticipants(Address deviceAddr, Address[] participantsCompatible)
void addParticipant(Address addr)
void addParticipantDevice(Address participantAddress, Address deviceAddress)
void addParticipants(Address[] addresses)
boolean canHandleParticipants()
void compose()
ChatMessage createFileTransferMessage(Content initialContent)
ChatMessage createMessage(java.lang.String message)
void deleteHistory()
void deleteMessage(ChatMessage msg)
ChatMessage findMessage(java.lang.String messageId)
Participant findParticipant(Address addr)
ChatMessage[] getHistory(int nbMessage)
EventLog[] getHistoryEvents(int nbEvents)
EventLog[] getHistoryMessageEvents(int nbEvents)
ChatMessage[] getHistoryRange(int begin, int end)
EventLog[] getHistoryRangeEvents(int begin, int end)
EventLog[] getHistoryRangeMessageEvents(int begin, int end)
boolean hasBeenLeft()
boolean hasCapability(int mask)
void leave()
boolean limeAvailable()
void markAsRead()
void receiveChatMessage(ChatMessage msg)
void removeParticipant(Participant participant)
void removeParticipants(Participant[] participants)
void sendChatMessage(ChatMessage msg)
void setParticipantAdminStatus(Participant participant, boolean isAdmin)
void setParticipantDevices(Address partAddr, Address[] partDevices)
void addListener(ChatRoomListener listener)
void removeListener(ChatRoomListener listener)
void setUserData(java.lang.Object data)
java.lang.Object getUserData()