Linphone.ChatParams Class Reference

Inheritance diagram for Linphone.ChatParams:

Public Member Functions
Linphone.ChatParams	Clone ()

Properties
Linphone.ChatRoomBackend	Backend [get, set]
Linphone.ChatRoomEncryptionBackend	EncryptionBackend [get, set]
bool	EncryptionEnabled [get]
int	EphemeralLifetime [get, set]
Linphone.ChatRoomEphemeralMode	EphemeralMode [get, set]
bool	RttEnabled [get, set]

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

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

It is automatically created when you enable chat capabilities in the Linphone.ConferenceParams. If the Linphone.ChatRoom backend is Linphone.ChatRoomBackend.Basic, then no other parameter is required, but Linphone.ChatMessage sent and received won't benefit from all features a Linphone.ChatRoomBackend.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

Linphone.ChatParams Linphone.ChatParams.Clone ( )

inline

Clone a Linphone.ChatParams.

Returns

An allocated Linphone.ChatParams with the same parameters than params

Property Documentation

Linphone.ChatRoomBackend Linphone.ChatParams.Backend

getset

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

Returns

the Linphone.ChatRoomBackend

Linphone.ChatRoomEncryptionBackend Linphone.ChatParams.EncryptionBackend

getset

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

Returns

the Linphone.ChatRoomEncryptionBackend

bool Linphone.ChatParams.EncryptionEnabled

get

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

Returns

true if encryption is enabled, false otherwise

int Linphone.ChatParams.EphemeralLifetime

getset

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 "time" seconds.

See : linphone_chat_params_ephemeral_enabled()

Returns

the ephemeral lifetime (in seconds)

Linphone.ChatRoomEphemeralMode Linphone.ChatParams.EphemeralMode

getset

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

Returns

the ephemeral message mode Linphone.ChatRoomEphemeralMode

bool Linphone.ChatParams.RttEnabled

getset

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

---

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

• LinphoneWrapper.cs