ChatRoomDelegate
public protocol ChatRoomDelegate : AnyObject
Undocumented
-
onIsComposingReceived(chatRoom:
Default implementationremoteAddress: isComposing: ) Is composing notification callback prototype.
Default Implementation
Declaration
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
-
onMessageReceived(chatRoom:
Default implementationmessage: ) Callback used to notify a chat room that a message has been received.
Default Implementation
Declaration
Swift
func onMessageReceived(chatRoom: ChatRoom, message: ChatMessage)
Parameters
chatRoom
LinphoneChatRoom object
message
The LinphoneChatMessage that has been received
-
onNewEvent(chatRoom:
Default implementationeventLog: ) -
onChatMessageReceived(chatRoom:
Default implementationeventLog: ) -
onChatMessageSending(chatRoom:
Default implementationeventLog: ) -
onChatMessageSent(chatRoom:
Default implementationeventLog: ) -
onParticipantAdded(chatRoom:
Default implementationeventLog: ) -
onParticipantRemoved(chatRoom:
Default implementationeventLog: ) -
onParticipantAdminStatusChanged(chatRoom:
Default implementationeventLog: ) Callback used to notify a chat room that the admin status of a participant has been changed.
Default Implementation
Parameters
chatRoom
LinphoneChatRoom object
eventLog
LinphoneEventLog The event to be notified
-
onStateChanged(chatRoom:
Default implementationnewState: ) -
onSecurityEvent(chatRoom:
Default implementationeventLog: ) -
onSubjectChanged(chatRoom:
Default implementationeventLog: ) -
onUndecryptableMessageReceived(chatRoom:
Default implementationmessage: ) Callback used to notify a chat room that a message has been received but we were unable to decrypt it.
Default Implementation
Declaration
Swift
func onUndecryptableMessageReceived(chatRoom: ChatRoom, message: ChatMessage)
Parameters
chatRoom
LinphoneChatRoom involved in this conversation
message
The LinphoneChatMessage that has been received
-
onParticipantDeviceAdded(chatRoom:
Default implementationeventLog: ) -
onParticipantDeviceRemoved(chatRoom:
Default implementationeventLog: ) -
onConferenceJoined(chatRoom:
Default implementationeventLog: ) -
onConferenceLeft(chatRoom:
Default implementationeventLog: ) -
onEphemeralEvent(chatRoom:
Default implementationeventLog: ) -
onEphemeralMessageTimerStarted(chatRoom:
Default implementationeventLog: ) 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.
Default Implementation
Parameters
chatRoom
LinphoneChatRoom object
eventLog
LinphoneEventLog The event to be notified
-
onEphemeralMessageDeleted(chatRoom:
Default implementationeventLog: ) -
onConferenceAddressGeneration(chatRoom:
Default implementation) 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.
Default Implementation
Declaration
Swift
func onConferenceAddressGeneration(chatRoom: ChatRoom)
Parameters
chatRoom
LinphoneChatRoom object
-
onParticipantRegistrationSubscriptionRequested(chatRoom:
Default implementationparticipantAddress: ) Callback used when a group chat room server is subscribing to registration state of a participant.
Default Implementation
Declaration
Parameters
chatRoom
LinphoneChatRoom object
participantAddress
LinphoneAddress object
-
onParticipantRegistrationUnsubscriptionRequested(chatRoom:
Default implementationparticipantAddress: ) Callback used when a group chat room server is unsubscribing to registration state of a participant.
Default Implementation
Declaration
Parameters
chatRoom
LinphoneChatRoom object
participantAddress
LinphoneAddress object
-
onChatMessageShouldBeStored(chatRoom:
Default implementationmessage: ) 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.
Default Implementation
Declaration
Swift
func onChatMessageShouldBeStored(chatRoom: ChatRoom, message: ChatMessage)
Parameters
chatRoom
LinphoneChatRoom object
message
The LinphoneChatMessage that is being received
-
onChatMessageParticipantImdnStateChanged(chatRoom:
Default implementationmessage: state: ) Callback used to notify a participant state has changed in a message of this chat room.
Default Implementation
Declaration
Swift
func onChatMessageParticipantImdnStateChanged(chatRoom: ChatRoom, message: ChatMessage, state: ParticipantImdnState)
Parameters
chatRoom
LinphoneChatRoom object
message
The LinphoneChatMessage for which a participant has it’s state changed
state
The LinphoneParticipantImdnState