linphone::ChatParams Class Reference

#include <chat_params.hh>

Inheritance diagram for linphone::ChatParams:

Public Member Functions
LINPHONECXX_PUBLIC	ChatParams (void *ptr, bool takeRef=true)
LINPHONECXX_PUBLIC _LinphoneChatParams *	cPtr ()
LINPHONECXX_PUBLIC linphone::ChatRoom::Backend	getBackend () const
LINPHONECXX_PUBLIC void	setBackend (linphone::ChatRoom::Backend backend)
LINPHONECXX_PUBLIC linphone::ChatRoom::EncryptionBackend	getEncryptionBackend () const
LINPHONECXX_PUBLIC void	setEncryptionBackend (linphone::ChatRoom::EncryptionBackend backend)
LINPHONECXX_PUBLIC bool	encryptionEnabled () const
LINPHONECXX_PUBLIC long	getEphemeralLifetime () const
LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void	setEphemeralLifetime (long time)
LINPHONECXX_PUBLIC linphone::ChatRoom::EphemeralMode	getEphemeralMode () const
LINPHONECXX_PUBLIC void	setEphemeralMode (linphone::ChatRoom::EphemeralMode mode)
LINPHONECXX_PUBLIC long	getEphemeralNotReadLifetime () const
LINPHONECXX_PUBLIC bool	rttEnabled () const
LINPHONECXX_PUBLIC void	enableRtt (bool rtt)
LINPHONECXX_PUBLIC linphone::Status	activateEphemeral (unsigned int lifetime)
LINPHONECXX_PUBLIC linphone::Status	activateEphemeral (unsigned int lifetime, unsigned int notReadLifetime)
LINPHONECXX_PUBLIC std::shared_ptr< linphone::ChatParams >	clone () const
LINPHONECXX_PUBLIC void	deactivateEphemeral ()

Detailed Description

Object defining settings strictly associated with ChatRoom objects such as ephemeral settings and backends.

It is automatically created when you enable chat capabilities in the ConferenceParams. 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

activateEphemeral() [1/2]

LINPHONECXX_PUBLIC linphone::Status linphone::ChatParams::activateEphemeral

(

unsigned int

lifetime

)

Set lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat.

After the message is read, it will be deleted after "lifetime" seconds. The "not read lifetime" timeout will remain unchanged and will be set to Core::getDefaultEphemeralNotReadLifetime() if it is never specified. When still not read, it will be deleted after "notReadLifetime" seconds to avoid being persistent.

See also

linphone_chat_room_activate_ephemeral()

Parameters

lifetime

The ephemeral lifetime, strictly positive

activateEphemeral() [2/2]

LINPHONECXX_PUBLIC linphone::Status linphone::ChatParams::activateEphemeral	(	unsigned int	lifetime,
		unsigned int	notReadLifetime
	)

Set lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat.

After the message is read, it will be deleted after "lifetime" seconds. When still not read, it will be deleted after "notReadLifetime" seconds to avoid being persistent.

See also

linphone_chat_room_activate_ephemeral()

Parameters

lifetime	The ephemeral lifetime, strictly positive
notReadLifetime	The ephemeral not read lifetime, strictly positive

clone()

LINPHONECXX_PUBLIC std::shared_ptr< linphone::ChatParams > linphone::ChatParams::clone

(

)

const

Clone a ChatParams.

Returns

An allocated ChatParams with the same parameters than params

deactivateEphemeral()

LINPHONECXX_PUBLIC void linphone::ChatParams::deactivateEphemeral

(

)

Deactivate new ephemeral messages in the text capabilities of the chat.

See also

ChatRoom::deactivateEphemeral()

enableRtt()

LINPHONECXX_PUBLIC void linphone::ChatParams::enableRtt

(

bool

rtt

)

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

Parameters

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

encryptionEnabled()

LINPHONECXX_PUBLIC bool linphone::ChatParams::encryptionEnabled

(

)

const

Get the encryption status of the text capabilities of the chat associated with the given parameters.

Returns

true if encryption is enabled, false otherwise

getBackend()

LINPHONECXX_PUBLIC linphone::ChatRoom::Backend linphone::ChatParams::getBackend

(

)

const

Get the backend implementation of the text capabilities of the chat associated with the given parameters.

Returns

the ChatRoom::Backend

getEncryptionBackend()

LINPHONECXX_PUBLIC linphone::ChatRoom::EncryptionBackend linphone::ChatParams::getEncryptionBackend

(

)

const

Get the encryption implementation of the text capabilities of the chat associated with the given parameters.

Returns

the ChatRoom::EncryptionBackend

getEphemeralLifetime()

LINPHONECXX_PUBLIC long linphone::ChatParams::getEphemeralLifetime

(

)

const

Get lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat.

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

See also

linphone_chat_room_activate_ephemeral()

Returns

the ephemeral lifetime (in seconds)

getEphemeralMode()

LINPHONECXX_PUBLIC linphone::ChatRoom::EphemeralMode linphone::ChatParams::getEphemeralMode

(

)

const

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

Returns

the ephemeral message mode ChatRoom::EphemeralMode

getEphemeralNotReadLifetime()

LINPHONECXX_PUBLIC long linphone::ChatParams::getEphemeralNotReadLifetime

(

)

const

Get not read lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat.

When still not read, it will be deleted after "notReadLifetime" seconds to avoid being persistent.

See also

linphone_chat_room_activate_ephemeral_2()

Returns

The ephemeral not read lifetime (in seconds)

rttEnabled()

LINPHONECXX_PUBLIC bool linphone::ChatParams::rttEnabled

(

)

const

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

Returns

true if real time text is enabled, false otherwise

setBackend()

LINPHONECXX_PUBLIC void linphone::ChatParams::setBackend

(

linphone::ChatRoom::Backend

backend

)

Set the backend implementation of these text capabilities of the chat parameters.

Parameters

backend

The ChatRoom::Backend enum value

setEncryptionBackend()

LINPHONECXX_PUBLIC void linphone::ChatParams::setEncryptionBackend

(

linphone::ChatRoom::EncryptionBackend

backend

)

Set the encryption backend implementation of these text capabilities of the chat parameters.

Parameters

backend

The ChatRoom::EncryptionBackend enum value

setEphemeralLifetime()

LINPHONECXX_PUBLIC LINPHONECXX_DEPRECATED void linphone::ChatParams::setEphemeralLifetime

(

long

time

)

Set lifetime (in seconds) for all new ephemeral messages in the text capabilities of the chat.

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

See also

linphone_chat_room_activate_ephemeral()

Deprecated:

20/02/2026 Use activateEphemeral() or deactivateEphemeral() instead.

setEphemeralMode()

LINPHONECXX_PUBLIC void linphone::ChatParams::setEphemeralMode

(

linphone::ChatRoom::EphemeralMode

mode

)

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

Parameters

mode	Ephemeral message mode ChatRoom::EphemeralMode.

---

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

• chat_params.hh