org.linphone.core

Interface ChatRoomListener

All Known Implementing Classes:

ChatRoomListenerStub

public interface ChatRoomListener

An object to handle the callbacks for the handling a LinphoneChatRoom objects.

Method Summary

Modifier and Type	Method and Description
void	onChatMessageParticipantImdnStateChanged(ChatRoom chatRoom, ChatMessage message, ParticipantImdnState state) Callback used to notify a participant state has changed in a message of this chat room.
void	onChatMessageReceived(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a chat message has been received.
void	onChatMessageSending(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a chat message is being sent.
void	onChatMessageSent(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a chat message has been sent.
void	onChatMessageShouldBeStored(ChatRoom chatRoom, ChatMessage message) Callback used to tell the core whether or not to store the incoming message in db or not using linphone_chat_message_set_to_be_stored.
void	onConferenceAddressGeneration(ChatRoom chatRoom) Callback used when a group chat room is created server-side to generate the address of the chat room.
void	onConferenceJoined(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room has been joined.
void	onConferenceLeft(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room has been left.
void	onEphemeralEvent(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that an ephemeral related event has been generated.
void	onEphemeralMessageDeleted(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that an ephemeral message has been deleted.
void	onEphemeralMessageTimerStarted(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that the lifespan of an ephemeral message before disappearing has started to decrease.
void	onIsComposingReceived(ChatRoom chatRoom, Address remoteAddress, boolean isComposing) Is composing notification callback prototype.
void	onMessageReceived(ChatRoom chatRoom, ChatMessage message) Callback used to notify a chat room that a message has been received.
void	onNewEvent(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that an event log has been created.
void	onParticipantAdded(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a participant has been added.
void	onParticipantAdminStatusChanged(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that the admin status of a participant has been changed.
void	onParticipantDeviceAdded(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a participant has been added.
void	onParticipantDeviceRemoved(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a participant has been removed.
void	onParticipantRegistrationSubscriptionRequested(ChatRoom chatRoom, Address participantAddress) Callback used when a group chat room server is subscribing to registration state of a participant.
void	onParticipantRegistrationUnsubscriptionRequested(ChatRoom chatRoom, Address participantAddress) Callback used when a group chat room server is unsubscribing to registration state of a participant.
void	onParticipantRemoved(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a chat room that a participant has been removed.
void	onSecurityEvent(ChatRoom chatRoom, EventLog eventLog) Callback used to notify a security event in the chat room.
void	onStateChanged(ChatRoom chatRoom, ChatRoom.State newState) Callback used to notify a chat room state has changed.
void	onSubjectChanged(ChatRoom chatRoom, EventLog eventLog) Callback used to notify that the subject of a chat room has changed.
void	onUndecryptableMessageReceived(ChatRoom chatRoom, ChatMessage message) Callback used to notify a chat room that a message has been received but we were unable to decrypt it.

Method Detail

onEphemeralMessageDeleted

void onEphemeralMessageDeleted(@NonNull
                               ChatRoom chatRoom,
                               @NonNull
                               EventLog eventLog)

Callback used to notify a chat room that an ephemeral message has been deleted.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onParticipantRegistrationSubscriptionRequested

void onParticipantRegistrationSubscriptionRequested(@NonNull
                                                    ChatRoom chatRoom,
                                                    @NonNull
                                                    Address participantAddress)

Callback used when a group chat room server is subscribing to registration
state of a participant.

Parameters:

chatRoom - LinphoneChatRoom object

participantAddress - LinphoneAddress object

onEphemeralEvent

void onEphemeralEvent(@NonNull
                      ChatRoom chatRoom,
                      @NonNull
                      EventLog eventLog)

Callback used to notify a chat room that an ephemeral related event has been
generated.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onStateChanged

void onStateChanged(@NonNull
                    ChatRoom chatRoom,
                    ChatRoom.State newState)

Callback used to notify a chat room state has changed.

Parameters:

chatRoom - LinphoneChatRoom object

newState - The new LinphoneChatRoomState of the chat room

onUndecryptableMessageReceived

void onUndecryptableMessageReceived(@NonNull
                                    ChatRoom chatRoom,
                                    @NonNull
                                    ChatMessage message)

Callback used to notify a chat room that a message has been received but we
were unable to decrypt it.

Parameters:

chatRoom - LinphoneChatRoom involved in this conversation

message - The LinphoneChatMessage that has been received

onChatMessageParticipantImdnStateChanged

void onChatMessageParticipantImdnStateChanged(@NonNull
                                              ChatRoom chatRoom,
                                              @NonNull
                                              ChatMessage message,
                                              @NonNull
                                              ParticipantImdnState state)

Callback used to notify a participant state has changed in a message of this
chat room.

Parameters:

chatRoom - LinphoneChatRoom object

message - The LinphoneChatMessage for which a participant has it's state
changed

state - The LinphoneParticipantImdnState

onChatMessageSent

void onChatMessageSent(@NonNull
                       ChatRoom chatRoom,
                       @NonNull
                       EventLog eventLog)

Callback used to notify a chat room that a chat message has been sent.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onParticipantDeviceAdded

void onParticipantDeviceAdded(@NonNull
                              ChatRoom chatRoom,
                              @NonNull
                              EventLog eventLog)

Callback used to notify a chat room that a participant has been added.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onChatMessageShouldBeStored

void onChatMessageShouldBeStored(@NonNull
                                 ChatRoom chatRoom,
                                 @NonNull
                                 ChatMessage message)

Callback used to tell the core whether or not to store the incoming message in
db or not using linphone_chat_message_set_to_be_stored.

Parameters:

chatRoom - LinphoneChatRoom object

message - The LinphoneChatMessage that is being received

onIsComposingReceived

void onIsComposingReceived(@NonNull
                           ChatRoom chatRoom,
                           @NonNull
                           Address remoteAddress,
                           boolean isComposing)

Is composing notification callback prototype.

Parameters:

chatRoom - LinphoneChatRoom involved in the conversation

remoteAddress - The LinphoneAddress that has sent the is-composing
notification

isComposing - A boolean value telling whether the remote is composing or
not

onChatMessageReceived

void onChatMessageReceived(@NonNull
                           ChatRoom chatRoom,
                           @NonNull
                           EventLog eventLog)

Callback used to notify a chat room that a chat message has been received.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onSecurityEvent

void onSecurityEvent(@NonNull
                     ChatRoom chatRoom,
                     @NonNull
                     EventLog eventLog)

Callback used to notify a security event in the chat room.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onChatMessageSending

void onChatMessageSending(@NonNull
                          ChatRoom chatRoom,
                          @NonNull
                          EventLog eventLog)

Callback used to notify a chat room that a chat message is being sent.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onNewEvent

void onNewEvent(@NonNull
                ChatRoom chatRoom,
                @NonNull
                EventLog eventLog)

Callback used to notify a chat room that an event log has been created.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onParticipantAdded

void onParticipantAdded(@NonNull
                        ChatRoom chatRoom,
                        @NonNull
                        EventLog eventLog)

Callback used to notify a chat room that a participant has been added.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onParticipantRegistrationUnsubscriptionRequested

void onParticipantRegistrationUnsubscriptionRequested(@NonNull
                                                      ChatRoom chatRoom,
                                                      @NonNull
                                                      Address participantAddress)

Callback used when a group chat room server is unsubscribing to registration
state of a participant.

Parameters:

chatRoom - LinphoneChatRoom object

participantAddress - LinphoneAddress object

onParticipantDeviceRemoved

void onParticipantDeviceRemoved(@NonNull
                                ChatRoom chatRoom,
                                @NonNull
                                EventLog eventLog)

Callback used to notify a chat room that a participant has been removed.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onConferenceLeft

void onConferenceLeft(@NonNull
                      ChatRoom chatRoom,
                      @NonNull
                      EventLog eventLog)

Callback used to notify a chat room has been left.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onEphemeralMessageTimerStarted

void onEphemeralMessageTimerStarted(@NonNull
                                    ChatRoom chatRoom,
                                    @NonNull
                                    EventLog eventLog)

Callback used to notify a chat room that the lifespan of an ephemeral message
before disappearing has started to decrease.

This callback is called when the ephemeral message is read by the receiver.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onParticipantAdminStatusChanged

void onParticipantAdminStatusChanged(@NonNull
                                     ChatRoom chatRoom,
                                     @NonNull
                                     EventLog eventLog)

Callback used to notify a chat room that the admin status of a participant has
been changed.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onConferenceAddressGeneration

void onConferenceAddressGeneration(@NonNull
                                   ChatRoom chatRoom)

Callback used when a group chat room is created server-side to generate the
address of the chat room.

The function linphone_chat_room_set_conference_address needs to be called by
this callback.

Parameters:

chatRoom - LinphoneChatRoom object

onConferenceJoined

void onConferenceJoined(@NonNull
                        ChatRoom chatRoom,
                        @NonNull
                        EventLog eventLog)

Callback used to notify a chat room has been joined.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onMessageReceived

void onMessageReceived(@NonNull
                       ChatRoom chatRoom,
                       @NonNull
                       ChatMessage message)

Callback used to notify a chat room that a message has been received.

Parameters:

chatRoom - LinphoneChatRoom object

message - The LinphoneChatMessage that has been received

onSubjectChanged

void onSubjectChanged(@NonNull
                      ChatRoom chatRoom,
                      @NonNull
                      EventLog eventLog)

Callback used to notify that the subject of a chat room has changed.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified

onParticipantRemoved

void onParticipantRemoved(@NonNull
                          ChatRoom chatRoom,
                          @NonNull
                          EventLog eventLog)

Callback used to notify a chat room that a participant has been removed.

Parameters:

chatRoom - LinphoneChatRoom object

eventLog - LinphoneEventLog The event to be notified