Linphone.ChatRoom Class Reference

Inheritance diagram for Linphone.ChatRoom:

Public Member Functions
void	AddParticipant (Linphone.Address addr)
bool	AddParticipants (IEnumerable< Linphone.Address > addresses)
void	AllowCpim ()
void	AllowMultipart ()
bool	CanHandleParticipants ()
int	Close ()
void	Compose ()
void	ComposeTextMessage ()
void	ComposeVoiceMessage ()
Linphone.ChatMessage	CreateEmptyMessage ()
Linphone.ChatMessage	CreateFileTransferMessage (Linphone.Content initialContent)
Linphone.ChatMessage	CreateForwardMessage (Linphone.ChatMessage message)
Linphone.ChatMessage	CreateMessage (string message)
Linphone.ChatMessage	CreateMessageFromUtf8 (string message)
Linphone.ChatMessage	CreateReplacesMessage (Linphone.ChatMessage message)
Linphone.ChatMessage	CreateReplyMessage (Linphone.ChatMessage message)
Linphone.ChatMessage	CreateVoiceRecordingMessage (Linphone.Recorder recorder)
void	DeleteHistory ()
void	DeleteMessage (Linphone.ChatMessage message)
bool	EphemeralSupportedByAllParticipants ()
Linphone.EventLog	FindEventLog (string messageId)
Linphone.ChatMessage	FindMessage (string messageId)
Linphone.Participant	FindParticipant (Linphone.Address address)
IEnumerable< Linphone.Content >	GetDocumentContentsRange (int begin, int end)
IEnumerable< Linphone.EventLog >	GetHistory (int nbMessage, uint filters)
IEnumerable< Linphone.ChatMessage >	GetHistory (int nbMessage)
IEnumerable< Linphone.EventLog >	GetHistoryEvents (int nbEvents)
IEnumerable< Linphone.EventLog >	GetHistoryMessageEvents (int nbEvents)
IEnumerable< Linphone.EventLog >	GetHistoryRange (int begin, int end, uint filters)
IEnumerable< Linphone.ChatMessage >	GetHistoryRange (int begin, int end)
IEnumerable< Linphone.EventLog >	GetHistoryRangeBetween (Linphone.EventLog firstEvent, Linphone.EventLog lastEvent, uint filters)
IEnumerable< Linphone.EventLog >	GetHistoryRangeEvents (int begin, int end)
IEnumerable< Linphone.EventLog >	GetHistoryRangeMessageEvents (int begin, int end)
IEnumerable< Linphone.EventLog >	GetHistoryRangeNear (uint before, uint after, Linphone.EventLog ev, uint filters)
int	GetHistorySize (uint filters)
IEnumerable< Linphone.Content >	GetMediaContentsRange (int begin, int end)
bool	HasBeenLeft ()
bool	HasCapability (int mask)
void	Leave ()
void	MarkAsRead ()
void	NominateAdminAndLeave (Linphone.Address newAdmin)
void	NotifyParticipantDeviceRegistration (Linphone.Address participantDevice)
void	ReceiveChatMessage (Linphone.ChatMessage message)
void	RemoveParticipant (Linphone.Participant participant)
void	RemoveParticipants (IEnumerable< Linphone.Participant > participants)
void	RetractMessage (Linphone.ChatMessage message)
Linphone.EventLog	SearchChatMessageByText (string text, Linphone.EventLog from, Linphone.SearchDirection direction)
void	SetParticipantAdminStatus (Linphone.Participant participant, bool isAdmin)
void	SetParticipantDevices (Linphone.Address participantAddress, IEnumerable< Linphone.ParticipantDeviceIdentity > deviceIdentities)
void	StopComposing ()

Static Public Member Functions
static string	StateToString (Linphone.ChatRoomState state)

Properties
ChatRoomListener	Listener [get, set]
Linphone.Account	Account [get]
Linphone.Call	Call [get]
uint	Capabilities [get]
uint	Char [get]
IEnumerable< Linphone.Address >	ComposingAddresses [get]
IEnumerable< Linphone.ComposingParticipant >	ComposingParticipants [get]
Linphone.Address	ConferenceAddress [get, set]
Linphone.ConferenceInfo	ConferenceInfo [get]
Linphone.Core	Core [get]
long	CreationTime [get]
Linphone.ChatRoomParams	CurrentParams [get]
IEnumerable< Linphone.Content >	DocumentContents [get]
int	DocumentContentsSize [get]
bool	EphemeralEnabled [get, set]
int	EphemeralLifetime [get, set]
Linphone.ChatRoomEphemeralMode	EphemeralMode [get, set]
int	EphemeralNotReadLifetime [get, set]
int	HistoryEventsSize [get]
int	HistorySize [get]
string	Identifier [get]
bool	IsEmpty [get]
bool	IsReadOnly [get]
bool	IsRemoteComposing [get]
Linphone.ChatMessage	LastMessageInHistory [get]
long	LastUpdateTime [get]
Linphone.Address	LocalAddress [get]
Linphone.Participant	Me [get]
IEnumerable< Linphone.Content >	MediaContents [get]
int	MediaContentsSize [get]
bool	Muted [get, set]
int	NbParticipants [get]
Linphone.ConferenceParams	Params [get]
IEnumerable< Linphone.Participant >	Participants [get]
Linphone.Address	PeerAddress [get]
string	RemoteComposingContentType [get]
Linphone.ChatRoomSecurityLevel	SecurityLevel [get]
Linphone.ChatRoomState	State [get]
string	Subject [get, set]
string	SubjectUtf8 [get, set]
IEnumerable< Linphone.ChatMessage >	UnreadHistory [get]
int	UnreadMessagesCount [get]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

A chat room is the place where Linphone.ChatMessage are exchanged.

To create (or find) a Linphone.ChatRoom, you first need a Linphone.ChatRoomParams object. A chat room is uniquely identified by it's local and remote SIP addresses, meaning you can only have one chat room between two accounts (unless the backend is Linphone.ChatRoomBackend.FlexisipChat). Then you can call Linphone.Core.SearchChatRoom() or Linphone.Core.CreateChatRoom(). Be careful as a Linphone.ChatRoomBackend.FlexisipChat backend Linphone.ChatRoom will be created asynchronously, so make sure you add a Linphone.ChatRoomListener to the returned object to be notified when it will be in state Linphone.ChatRoomState.Created. All chat rooms are loaded from database when the Linphone.Core starts, and you can get them using Linphone.Core.ChatRooms. This method doesn't return empty chat rooms nor ones for which the local address doesn't match an existing Linphone.Account identity, unless you specify otherwise in the [misc] section of your configuration file by setting hide_empty_chat_rooms=0 and/or hide_chat_rooms_from_removed_proxies=0.

Member Function Documentation

void Linphone.ChatRoom.AddParticipant ( Linphone.Address  addr )

inline

Adds a participant to a chat room.

This may fail if this type of chat room does not handle participants. Use Linphone.ChatRoom.CanHandleParticipants() to know if this chat room handles participants.

Parameters

addr	The address of the participant to add to the chat room

bool Linphone.ChatRoom.AddParticipants ( IEnumerable< Linphone.Address >  addresses )

inline

Adds several participants to a chat room at once.

This may fail if this type of chat room does not handle participants. Use Linphone.ChatRoom.CanHandleParticipants() to know if this chat room handles participants.

Parameters

addresses

The participants to add. A list of Linphone.Address objects.

Returns

true if everything is OK, false otherwise

void Linphone.ChatRoom.AllowCpim ( )

inline

Allow cpim on a basic chat room .

void Linphone.ChatRoom.AllowMultipart ( )

inline

Allow multipart on a basic chat room .

bool Linphone.ChatRoom.CanHandleParticipants ( )

inline

Tells whether a chat room is able to handle participants.

Returns

true if the chat room can handle participants, false otherwise

int Linphone.ChatRoom.Close ( )

inline

Terminates a chat room and instruct the server to remove all participants.

Returns

0 if the termination is successful, -1 otherwise.

void Linphone.ChatRoom.Compose ( )

inline

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

Deprecated : 24/06/2025 use Linphone.ChatRoom.ComposeTextMessage() instead.

void Linphone.ChatRoom.ComposeTextMessage ( )

inline

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

void Linphone.ChatRoom.ComposeVoiceMessage ( )

inline

Notifies the destination of the chat message being composed that the user is recording a new voice message.

Linphone.ChatMessage Linphone.ChatRoom.CreateEmptyMessage ( )

inline

Creates an empty message attached to the given chat room.

Returns

a new Linphone.ChatMessage

Linphone.ChatMessage Linphone.ChatRoom.CreateFileTransferMessage ( Linphone.Content  initialContent )

inline

Creates a message attached to the given chat room with a particular content.

Use Linphone.ChatMessage.Send() to initiate the transfer

Parameters

initialContent

Linphone.Content initial content.

Returns

a new Linphone.ChatMessage

Linphone.ChatMessage Linphone.ChatRoom.CreateForwardMessage ( Linphone.ChatMessage  message )

inline

Creates a forward message attached to the given chat room with a particular message.

Parameters

message

Linphone.ChatMessage message to be forwarded.

Returns

a new Linphone.ChatMessage

Linphone.ChatMessage Linphone.ChatRoom.CreateMessage ( string  message )

inline

Creates a message attached to the given chat room with a plain text content filled with the given message.

Parameters

message

text message, null if absent.

Returns

a new Linphone.ChatMessage

Deprecated : 01/07/2020. Use Linphone.ChatRoom.CreateMessageFromUtf8() instead.

Linphone.ChatMessage Linphone.ChatRoom.CreateMessageFromUtf8 ( string  message )

inline

Creates a message attached to the given chat room with a plain text content filled with the given message.

Introduced in 01/07/2020

Parameters

message

text message in UTF8, null if absent.

Returns

a new Linphone.ChatMessage

Linphone.ChatMessage Linphone.ChatRoom.CreateReplacesMessage ( Linphone.ChatMessage  message )

inline

Creates a replaces message that will edit the original message.

Parameters

message

Linphone.ChatMessage message to edit.

Returns

a new Linphone.ChatMessage

Linphone.ChatMessage Linphone.ChatRoom.CreateReplyMessage ( Linphone.ChatMessage  message )

inline

Creates a reply message attached to the given chat room with a particular message.

Parameters

message

Linphone.ChatMessage message to reply to.

Returns

a new Linphone.ChatMessage

Linphone.ChatMessage Linphone.ChatRoom.CreateVoiceRecordingMessage ( Linphone.Recorder  recorder )

inline

Creates a chat message with a voice recording attached to the given chat room.

Warning : If the recorder isn't in Closed state, it will return an empty message!

Parameters

recorder

the Linphone.Recorder object used to record the voice message.

Returns

a new Linphone.ChatMessage

void Linphone.ChatRoom.DeleteHistory ( )

inline

Delete all messages from the history.

void Linphone.ChatRoom.DeleteMessage ( Linphone.ChatMessage  message )

inline

Delete a message from the chat room history.

Parameters

message

The Linphone.ChatMessage object to remove.

bool Linphone.ChatRoom.EphemeralSupportedByAllParticipants ( )

inline

Check if all participants support ephemeral messages.

It doesn't prevent to send ephemeral messages in the room but those who don't support it won't delete messages after lifetime has expired. The check is done by verifying the participant's advertised capabilities (+org.linphone.specs parameter).

See : Linphone.ChatRoom.EphemeralEnabled()

Returns

true if all participants in the chat room support ephemeral messages, false otherwise

Linphone.EventLog Linphone.ChatRoom.FindEventLog ( string  messageId )

inline

Gets the event log sent or received in this chat room that matches a chat message with the given message_id.

Parameters

messageId

The id of the message to find

Returns

the Linphone.EventLog if found or null.

Linphone.ChatMessage Linphone.ChatRoom.FindMessage ( string  messageId )

inline

Gets the chat message sent or received in this chat room that matches the message_id.

Parameters

messageId

The id of the message to find

Returns

the Linphone.ChatMessage if found or null.

Linphone.Participant Linphone.ChatRoom.FindParticipant ( Linphone.Address  address )

inline

Finds a participant of a chat room from its address.

Parameters

address

The Linphone.Address to search in the list of participants of the chat room

Returns

The participant if found, null otherwise.

IEnumerable<Linphone.Content> Linphone.ChatRoom.GetDocumentContentsRange ( int  begin, int  end  )

inline

Gets the partial list of contents for which content-type starts with either text/ or application/.

Parameters

begin	The first content of the range to be retrieved. Most recent content has index 0.
end	The last content of the range to be retrieved. Oldest content has index of size (use Linphone.ChatRoom.DocumentContentsSize to retrieve size)

Returns

A list of contents considered as "document". A list of Linphone.Content objects.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistory ( int  nbMessage, uint  filters  )

inline

Gets nb_message most recent events from chat_room chat room, sorted from oldest to most recent.

Parameters

nbMessage	Number of events to retrieve. 0 means everything.
filters	The LinphoneChatRoomHistoryFilterMask mask to filter the results with Linphone.ChatRoomHistoryFilter

Returns

A list of A list of Linphone.EventLog objects.

IEnumerable<Linphone.ChatMessage> Linphone.ChatRoom.GetHistory ( int  nbMessage )

inline

Gets nb_message most recent messages from chat_room chat room, sorted from oldest to most recent.

Parameters

nbMessage

Number of message to retrieve. 0 means everything.

Returns

A list of A list of Linphone.ChatMessage objects.

Deprecated : 30/07/2024. Use Linphone.ChatRoom.History instead.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryEvents ( int  nbEvents )

inline

Gets nb_events most recent events from chat_room chat room, sorted from oldest to most recent.

Parameters

nbEvents

Number of events to retrieve. 0 means everything.

Returns

The list of the most recent events. A list of Linphone.EventLog objects.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryMessageEvents ( int  nbEvents )

inline

Gets nb_events most recent chat message events from chat_room chat room, sorted from oldest to most recent.

Parameters

nbEvents

Number of events to retrieve. 0 means everything.

Returns

A list A list of Linphone.EventLog objects.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryRange ( int  begin, int  end, uint  filters  )

inline

Gets the partial list of events in the given range, sorted from oldest to most recent.

Parameters

begin	The first event of the range to be retrieved. History most recent message has index 0.
end	The last event of the range to be retrieved. History oldest message has index of history size (use Linphone.ChatRoom.HistorySize to retrieve history size)
filters	The LinphoneChatRoomHistoryFilterMask mask to filter the results with Linphone.ChatRoomHistoryFilter

Returns

A list of A list of Linphone.EventLog objects.

IEnumerable<Linphone.ChatMessage> Linphone.ChatRoom.GetHistoryRange ( int  begin, int  end  )

inline

Gets the partial list of messages in the given range, sorted from oldest to most recent.

Parameters

begin	The first message of the range to be retrieved. History most recent message has index 0.
end	The last message of the range to be retrieved. History oldest message has index of history size (use Linphone.ChatRoom.HistorySize to retrieve history size)

Returns

A list of chat messages. A list of Linphone.ChatMessage objects.

Deprecated : 30/07/2024. Use Linphone.ChatRoom.HistoryRange instead.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryRangeBetween ( Linphone.EventLog  firstEvent, Linphone.EventLog  lastEvent, uint  filters  )

inline

Gets the partial list of messages between two given Linphone.EventLog, sorted from oldest to most recent.

If either first_event or last_event is null, then nothing is returned.

Parameters

firstEvent	The Linphone.EventLog object corresponding to the event.
lastEvent	The Linphone.EventLog object corresponding to the event.
filters	The LinphoneChatRoomHistoryFilterMask mask to filter the results with Linphone.ChatRoomHistoryFilter

Returns

A list of A list of Linphone.EventLog objects. between the two provided events, if any.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryRangeEvents ( int  begin, int  end  )

inline

Gets the partial list of events in the given range, sorted from oldest to most recent.

Parameters

begin	The first event of the range to be retrieved. History most recent event has index 0.
end	The last event of the range to be retrieved. History oldest event has index of history size

Returns

The list of the found events. A list of Linphone.EventLog objects.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryRangeMessageEvents ( int  begin, int  end  )

inline

Gets the partial list of chat message events in the given range, sorted from oldest to most recent.

Parameters

begin	The first event of the range to be retrieved. History most recent event has index 0.
end	The last event of the range to be retrieved. History oldest event has index of history size

Returns

The list of chat message events. A list of Linphone.EventLog objects.

IEnumerable<Linphone.EventLog> Linphone.ChatRoom.GetHistoryRangeNear ( uint  before, uint  after, Linphone.EventLog  ev, uint  filters  )

inline

Gets the partial list of messages in the given range near the Linphone.EventLog provided, sorted from oldest to most recent.

If before and after are both set to 0, the returned list is empty.

Parameters

before	The number of messages to retrieve before the event provided.
after	The number of messages to retrieve after the event provided.
ev	The Linphone.EventLog object corresponding to the event.
filters	The LinphoneChatRoomHistoryFilterMask mask to filter the results with Linphone.ChatRoomHistoryFilter

Returns

A list of A list of Linphone.EventLog objects. near the event provided included.

int Linphone.ChatRoom.GetHistorySize ( uint  filters )

inline

Gets the number of messages in a chat room.

Parameters

filters

The LinphoneChatRoomHistoryFilterMask mask to filter the result with Linphone.ChatRoomHistoryFilter

Returns

the number of messages.

IEnumerable<Linphone.Content> Linphone.ChatRoom.GetMediaContentsRange ( int  begin, int  end  )

inline

Gets the partial list of contents for which content-type starts with either video/, audio/ or image/.

Parameters

begin	The first content of the range to be retrieved. Most recent content has index 0.
end	The last content of the range to be retrieved. Oldest content has index of size (use Linphone.ChatRoom.MediaContentsSize to retrieve size)

Returns

A list of contents considered as "media". A list of Linphone.Content objects.

bool Linphone.ChatRoom.HasBeenLeft ( )

inline

Returns whether or not the chat room has been left.

Returns

true if the chat room has been left, false otherwise.

Deprecated : 16/03/2022 use Linphone.ChatRoom.IsReadOnly() instead.

bool Linphone.ChatRoom.HasCapability ( int  mask )

inline

Checks if a chat room has given capabilities.

Parameters

mask	a LinphoneChatRoomCapabilitiesMask mask

Returns

true if the mask matches, false otherwise

void Linphone.ChatRoom.Leave ( )

inline

Leaves a chat room.

void Linphone.ChatRoom.MarkAsRead ( )

inline

Mark all messages of the conversation as read.

void Linphone.ChatRoom.NominateAdminAndLeave ( Linphone.Address  newAdmin )

inline

Nominates a new admin and then leaves a chat room.

Parameters

newAdmin

The Linphone.Address of the new admin

Note : The local participant will not leave the chat room if the new admin cannot be nominated

void Linphone.ChatRoom.NotifyParticipantDeviceRegistration ( Linphone.Address  participantDevice )

inline

Notifies the chatroom that a participant device has just registered.

This function is meaningful only for server implementation of chatroom, and shall not by used by client applications.

Parameters

participantDevice

list of the participant devices to be used by the group chat room

void Linphone.ChatRoom.ReceiveChatMessage ( Linphone.ChatMessage  message )

inline

Used to receive a chat message when using async mechanism with IM enchat_roomyption engine.

Parameters

message

Linphone.ChatMessage object

void Linphone.ChatRoom.RemoveParticipant ( Linphone.Participant  participant )

inline

Removes a participant of a chat room.

Parameters

participant

The participant to remove from the chat room

void Linphone.ChatRoom.RemoveParticipants ( IEnumerable< Linphone.Participant >  participants )

inline

Removes several participants of a chat room at once.

Parameters

participants

The participants to remove. A list of Linphone.Participant objects.

void Linphone.ChatRoom.RetractMessage ( Linphone.ChatMessage  message )

inline

Deletes the content of a previously sent message for both sender and receivers.

Message will still appear in the conversation history but will be empty. You can still delete it from history using Linphone.ChatRoom.DeleteMessage().

Parameters

message

The Linphone.ChatMessage object to delete.

Linphone.EventLog Linphone.ChatRoom.SearchChatMessageByText ( string  text, Linphone.EventLog  from, Linphone.SearchDirection  direction  )

inline

Searches chat messages by text.

Parameters

text	The text to search in messages
from	The Linphone.EventLog object corresponding to the event where to start the search
direction	The Linphone.SearchDirection where to search, LinphoneSearchDirectionUp will search older messages while LinphoneSearchDirectionDown will search newer messages

Returns

the Linphone.EventLog corresponding to the message if found or null.

void Linphone.ChatRoom.SetParticipantAdminStatus ( Linphone.Participant  participant, bool  isAdmin  )

inline

Changes the admin status of a participant of a chat room (you need to be an admin yourself to do this).

Parameters

participant	The Participant for which to change the admin status
isAdmin	A boolean value telling whether the participant should now be an admin or not

void Linphone.ChatRoom.SetParticipantDevices ( Linphone.Address  participantAddress, IEnumerable< Linphone.ParticipantDeviceIdentity >  deviceIdentities  )

inline

Sets the list of participant devices in the form of SIP URIs with GRUUs for a given participant.

This function is meaningful only for server implementation of chatroom, and shall not by used by client applications.

Parameters

participantAddress	The participant address
deviceIdentities	List of the participant devices to be used by the group chat room A list of Linphone.ParticipantDeviceIdentity objects.

static string Linphone.ChatRoom.StateToString ( Linphone.ChatRoomState  state )

inlinestatic

Converts a Linphone.ChatRoomState enum to a string.

Parameters

state

a Linphone.ChatRoomState to convert to string

Returns

the string representation of the Linphone.ChatRoomState

void Linphone.ChatRoom.StopComposing ( )

inline

Notifies the destination of the chat message that the user is no longer composing.

Property Documentation

Linphone.Account Linphone.ChatRoom.Account

get

Returns the local account to which this chat room is related.

Returns

the related Linphone.Account object if any, null otherwise.

Linphone.Call Linphone.ChatRoom.Call

get

Gets the current call associated to this chatroom if any To commit a message, use Linphone.ChatMessage.Send()

Returns

Linphone.Call or null.

uint Linphone.ChatRoom.Capabilities

get

Gets the capabilities of a chat room.

Returns

The capabilities of the chat room (as a LinphoneChatRoomCapabilitiesMask)

uint Linphone.ChatRoom.Char

get

When realtime text is enabled in a Linphone.Call (see Linphone.CallParams.RealtimeTextEnabled()), LinphoneCoreIsComposingReceivedCb is called everytime a Real-Time Text character is received from peer.

Linphone.ChatRoom.Char pops a character previously received from the receive queue, and returns it. When a new line character is received, a Linphone.ChatMessage is automatically created with received characters and notified to the application through the Linphone.CoreListener or Linphone.ChatRoomListener interfaces.

Returns

RFC 4103/T.140 char

IEnumerable<Linphone.Address> Linphone.ChatRoom.ComposingAddresses

get

Gets the list of participants that are currently composing.

Returns

List of addresses that are in the is_composing state. A list of Linphone.Address objects.

IEnumerable<Linphone.ComposingParticipant> Linphone.ChatRoom.ComposingParticipants

get

Gets the list of participants that are currently composing.

Returns

List of Linphone.ComposingParticipant that are in the is_composing state. A list of Linphone.ComposingParticipant objects.

Linphone.Address Linphone.ChatRoom.ConferenceAddress

getset

Gets the conference address of the chat room.

Returns

The conference address of the chat room or null if this type of chat room is not conference based.

Linphone.ConferenceInfo Linphone.ChatRoom.ConferenceInfo

get

Gets the conference information associated to the chatroom.

Returns

the Linphone.ConferenceInfo.

Linphone.Core Linphone.ChatRoom.Core

get

Returns back pointer to Linphone.Core object.

Returns

the Linphone.Core object this chat room is attached to.

long Linphone.ChatRoom.CreationTime

get

Returns the creation time for the chat room.

Returns

the time at which the chat room was created

Linphone.ChatRoomParams Linphone.ChatRoom.CurrentParams

get

Returns current parameters associated with the chat room.

This is typically the parameters passed during the Linphone.ChatRoom creation process to Linphone.Core.CreateChatRoom() or some default parameters if no Linphone.ChatRoomParams was explicitely passed during Linphone.ChatRoom creation.

Returns

the current Linphone.ChatRoomParams parameters.

Deprecated : 17/07/2025. Use Linphone.ChatRoom.Params instead.

IEnumerable<Linphone.Content> Linphone.ChatRoom.DocumentContents

get

Gets all contents for which content-type starts with either text/ or application/.

Returns

A list of contents considered as "document". A list of Linphone.Content objects.

int Linphone.ChatRoom.DocumentContentsSize

get

Gets the number of document contents (see Linphone.ChatRoom.DocumentContents).

Returns

the number of document contents for that Linphone.ChatRoom.

bool Linphone.ChatRoom.EphemeralEnabled

getset

Returns whether or not the ephemeral message feature is enabled in the chat room.

Returns

true if ephemeral is enabled, false otherwise.

int Linphone.ChatRoom.EphemeralLifetime

getset

Gets lifetime (in seconds) for all new ephemeral messages in the chat room.

After the message is read, it will be deleted after "time" seconds.

See : Linphone.ChatRoom.EphemeralEnabled()

Returns

the ephemeral lifetime (in seconds)

Linphone.ChatRoomEphemeralMode Linphone.ChatRoom.EphemeralMode

getset

Gets the ephemeral mode of the chat room.

See : Linphone.ChatRoom.EphemeralEnabled()

Returns

the ephemeral mode Linphone.ChatRoomEphemeralMode

int Linphone.ChatRoom.EphemeralNotReadLifetime

getset

Gets not-read lifetime (in seconds) for all new ephemeral messages in the chat room.

If the message is not read, it will be deleted after "time" seconds.

See : Linphone.ChatRoom.EphemeralEnabled()

Returns

the ephemeral not-read lifetime (in seconds)

int Linphone.ChatRoom.HistoryEventsSize

get

Gets the number of events in a chat room.

Returns

the number of events.

int Linphone.ChatRoom.HistorySize

get

Gets the number of messages in a chat room.

Returns

the number of messages.

Deprecated : 30/07/2024. Use Linphone.ChatRoom.HistorySize instead.

string Linphone.ChatRoom.Identifier

get

Returns the chat room identifier.

Warning : This method returns a null pointer if the ChatRoom is in the Instantiated state

Returns

the conference identifier.

bool Linphone.ChatRoom.IsEmpty

get

Returns whether or not a Linphone.ChatRoom has at least one Linphone.ChatMessage or not.

Returns

true if there are no Linphone.ChatMessage, false otherwise.

bool Linphone.ChatRoom.IsReadOnly

get

Returns whether or not a message can be sent using this chat room.

A chat room may be read only until it's created, or when it's a group you have left.

Returns

true if a chat message can't be sent in it, false otherwise.

bool Linphone.ChatRoom.IsRemoteComposing

get

Tells whether the remote is currently composing a message.

Returns

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

Linphone.ChatMessage Linphone.ChatRoom.LastMessageInHistory

get

Gets the last chat message sent or received in this chat room.

Returns

the latest Linphone.ChatMessage or null if no message.

long Linphone.ChatRoom.LastUpdateTime

get

Returns the last updated time for the chat room.

Returns

the last updated time

Linphone.Address Linphone.ChatRoom.LocalAddress

get

Get the local address associated to this chat room.

Warning : This method returns a guessed address based on the me participant if the ChatRoom is in the Instantiated state

Returns

The local address.

Linphone.Participant Linphone.ChatRoom.Me

get

Gets the participant representing myself in the chat room.

Returns

The participant representing myself in the conference or null if me is not set.

IEnumerable<Linphone.Content> Linphone.ChatRoom.MediaContents

get

Gets all contents for which content-type starts with either video/, audio/ or image/.

Returns

A list of contents considered as "media". A list of Linphone.Content objects.

int Linphone.ChatRoom.MediaContentsSize

get

Gets the number of media contents (see Linphone.ChatRoom.MediaContents).

Returns

the number of media contents for that Linphone.ChatRoom.

bool Linphone.ChatRoom.Muted

getset

Gets if a chat room has been flagged as muted (not by default).

A muted chat room isn't used to compute unread messages total count.

Returns

true if the chat room is muted, false otherwise.

int Linphone.ChatRoom.NbParticipants

get

Gets the number of participants in the chat room (that is without ourselves).

Returns

The number of participants in the chat room

Linphone.ConferenceParams Linphone.ChatRoom.Params

get

Returns current parameters associated with the chat room.

This is typically the parameters passed during the Linphone.ChatRoom creation process to Linphone.Core.CreateChatRoom() or some default parameters if no Linphone.ChatRoomParams was explicitely passed during Linphone.ChatRoom creation.

Returns

the current Linphone.ChatRoomParams parameters.

IEnumerable<Linphone.Participant> Linphone.ChatRoom.Participants

get

Gets the list of participants of a chat room.

Returns

A A list of Linphone.Participant objects. of the participants

Linphone.Address Linphone.ChatRoom.PeerAddress

get

Get the peer address associated to this chat room.

Warning : This method returns an invalid address if the ChatRoom is in the Instantiated state

Returns

The peer address.

string Linphone.ChatRoom.RemoteComposingContentType

get

Returns the content-type (if set) of what the remote is currently composing.

Returns

the content-type of what the remote is currently composing if set and if it's currently composing, null otherwise.

Linphone.ChatRoomSecurityLevel Linphone.ChatRoom.SecurityLevel

get

Gets the security level of a chat room.

Returns

The current Linphone.ChatRoomSecurityLevel of the chat room

Linphone.ChatRoomState Linphone.ChatRoom.State

get

Gets the state of the chat room.

Returns

The current Linphone.ChatRoomState of the chat room

string Linphone.ChatRoom.Subject

getset

Gets the subject of a chat room.

Returns

The subject of the chat room.

string Linphone.ChatRoom.SubjectUtf8

getset

Gets the subject of a chat room (as an UTF8 string)

Returns

The subject of the chat room.

IEnumerable<Linphone.ChatMessage> Linphone.ChatRoom.UnreadHistory

get

Gets all unread messages for this chat room, sorted from oldest to most recent.

Returns

A list of unread chat messages. A list of Linphone.ChatMessage objects.

int Linphone.ChatRoom.UnreadMessagesCount

get

Gets the number of unread messages in the chatroom.

Returns

the number of unread messages.

---

The documentation for this class was generated from the following file:

• LinphoneWrapper.cs