Object defining parameters for a ChatRoom. More...

#include <chat_room_params.hh>

Inheritance diagram for linphone::ChatRoomParams:

Public Member Functions
LINPHONECXX_PUBLIC	ChatRoomParams (void *ptr, bool takeRef=true)

LINPHONECXX_PUBLIC _LinphoneChatRoomParams *	cPtr ()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::ChatRoom::Backend	getBackend () const
	Get the backend implementation of the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setBackend (linphone::ChatRoom::Backend backend)
	Set the backend implementation of these chat room parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::ChatRoom::EncryptionBackend	getEncryptionBackend () const
	Get the encryption implementation of the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setEncryptionBackend (linphone::ChatRoom::EncryptionBackend backend)
	Set the encryption backend implementation of these chat room parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool	encryptionEnabled () const
	Get the encryption status of the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	enableEncryption (bool encrypted)
	Enables or disables encryption for the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED long	getEphemeralLifetime () const
	Get lifetime (in seconds) for all new ephemeral messages in the chat room. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setEphemeralLifetime (long time)
	Set lifetime (in seconds) for all new ephemral messages in the chat room. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::ChatRoom::EphemeralMode	getEphemeralMode () const
	Get the ephemeral message mode of the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setEphemeralMode (linphone::ChatRoom::EphemeralMode mode)
	Enables or disables forcing of ephemeral messages for the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool	groupEnabled () const
	Get the group chat status of the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	enableGroup (bool group)
	Enables or disables group chat for the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool	isValid () const
	Returns whether the given parameters are valid or not. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool	rttEnabled () const
	Get the real time text status of the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	enableRtt (bool rtt)
	Enables or disables real time text for the chat room associated with the given parameters. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::string	getSubject () const
	Get the subject of the chat room. More...

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setSubject (const std::string &subject)
	Set the subject of the chat room. More...

Detailed Description

Object defining parameters for a ChatRoom.

Can be created with Core::createDefaultChatRoomParams(). You can use isValid() to check if your configuration is valid or not. If the ChatRoom backend is ChatRoom::Backend::Basic, then no other parameter is required, but ChatMessage sent and received won't benefit from all features a ChatRoom::Backend::FlexisipChat can offer like conversation with multiple participants and a subject, end-to-end encryption, ephemeral messages, etc... but this type is the only one that can interoperate with other SIP clients or with non-flexisip SIP proxies.

Member Function Documentation

◆ enableEncryption()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::enableEncryption ( bool encrypted )

Enables or disables encryption for the chat room associated with the given parameters.

Parameters

encrypted true to enable encryption, false to disable.

Deprecated:: 20/05/2024. Use linphone_conference_params_enable_encryption() instead.

◆ enableGroup()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::enableGroup ( bool group )

Enables or disables group chat for the chat room associated with the given parameters.

Parameters

group true to enable group chat, false to disable (resulting in one-to-one chat room)

Deprecated:: 20/05/2024. Use ConferenceParams::enableGroup() instead.

◆ enableRtt()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::enableRtt ( bool rtt )

Enables or disables real time text for the chat room associated with the given parameters.

Parameters

rtt	true to enable real time text, false to disable.

Deprecated:: 20/05/2024. Use ChatParams::enableRtt() instead.

◆ encryptionEnabled()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ChatRoomParams::encryptionEnabled ( ) const

Get the encryption status of the chat room associated with the given parameters.

Returns: true if encryption is enabled, false otherwise

Deprecated:: 20/05/2024. Use ChatParams::encryptionEnabled() instead.

◆ getBackend()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::ChatRoom::Backend linphone::ChatRoomParams::getBackend ( ) const

Get the backend implementation of the chat room associated with the given parameters.

Returns: the ChatRoom::Backend

Deprecated:: 20/05/2024. Use ChatParams::getBackend() instead.

◆ getEncryptionBackend()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::ChatRoom::EncryptionBackend linphone::ChatRoomParams::getEncryptionBackend ( ) const

Get the encryption implementation of the chat room associated with the given parameters.

Returns: the ChatRoom::EncryptionBackend

Deprecated:: 20/05/2024. Use ChatParams::getEncryptionBackend() instead.

◆ getEphemeralLifetime()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED long linphone::ChatRoomParams::getEphemeralLifetime ( ) const

Get 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 also: linphone_chat_room_params_ephemeral_enabled()

Returns: the ephemeral lifetime (in seconds)

Deprecated:: 20/05/2024. Use ChatParams::getEphemeralLifetime() instead.

◆ getEphemeralMode()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED linphone::ChatRoom::EphemeralMode linphone::ChatRoomParams::getEphemeralMode ( ) const

Get the ephemeral message mode of the chat room associated with the given parameters.

Returns: the ephemeral message mode ChatRoom::EphemeralMode

Deprecated:: 20/05/2024. Use ChatParams::getEphemeralMode() instead.

◆ getSubject()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED std::string linphone::ChatRoomParams::getSubject ( ) const

Get the subject of the chat room.

Returns: The subject.

Deprecated:: 20/05/2024. Use ConferenceParams::getSubject() instead.

◆ groupEnabled()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ChatRoomParams::groupEnabled ( ) const

Get the group chat status of the chat room associated with the given parameters.

Returns: true if group chat is enabled, false if one-to-one

Deprecated:: 20/05/2024. Use ConferenceParams::groupEnabled() instead.

◆ isValid()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ChatRoomParams::isValid ( ) const

Returns whether the given parameters are valid or not.

Returns: true if the given parameters are valid, false otherwise

Deprecated:: 20/05/2024. Use ConferenceParams::isValid() instead.

◆ rttEnabled()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED bool linphone::ChatRoomParams::rttEnabled ( ) const

Get the real time text status of the chat room associated with the given parameters.

Returns: true if real time text is enabled, false otherwise

Deprecated:: 20/05/2024. Use ChatParams::rttEnabled() instead.

◆ setBackend()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::setBackend ( linphone::ChatRoom::Backend backend )

Set the backend implementation of these chat room parameters.

Parameters

backend The ChatRoom::Backend enum value

Deprecated:: 20/05/2024. Use ChatParams::setBackend() instead.

◆ setEncryptionBackend()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::setEncryptionBackend ( linphone::ChatRoom::EncryptionBackend backend )

Set the encryption backend implementation of these chat room parameters.

Parameters

backend The ChatRoom::EncryptionBackend enum value

Deprecated:: 20/05/2024. Use ChatParams::setEncryptionBackend() instead.

◆ setEphemeralLifetime()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::setEphemeralLifetime ( long time )

Set lifetime (in seconds) for all new ephemral messages in the chat room.

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

See also: linphone_chat_room_params_ephemeral_enabled()

Parameters

time	The ephemeral lifetime, default is disabled (0)

Deprecated:: 20/05/2024. Use ChatParams::setEphemeralLifetime() instead.

◆ setEphemeralMode()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::setEphemeralMode ( linphone::ChatRoom::EphemeralMode mode )

Enables or disables forcing of ephemeral messages for the chat room associated with the given parameters.

Parameters

mode	Ephemeral message mode ChatRoom::EphemeralMode.

Deprecated:: 20/05/2024. Use ChatParams::setEphemeralMode() instead.

◆ setSubject()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatRoomParams::setSubject ( const std::string & subject )

Set the subject of the chat room.

Parameters

subject The subject to set.

Deprecated:: 20/05/2024. Use ConferenceParams::setSubject() instead.

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

chat_room_params.hh

Public Member Functions

Detailed Description

Member Function Documentation

◆ enableEncryption()

◆ enableGroup()

◆ enableRtt()

◆ encryptionEnabled()

◆ getBackend()

◆ getEncryptionBackend()

◆ getEphemeralLifetime()

◆ getEphemeralMode()

◆ getSubject()

◆ groupEnabled()

◆ isValid()

◆ rttEnabled()

◆ setBackend()

◆ setEncryptionBackend()

◆ setEphemeralLifetime()

◆ setEphemeralMode()

◆ setSubject()