Liblinphone  5.5.0
Linphone.ChatRoomParams Class Reference
Inheritance diagram for Linphone.ChatRoomParams:
Linphone.LinphoneObject

Properties

Linphone.ChatRoomBackend Backend [get, set]
 
Linphone.ChatRoomEncryptionBackend EncryptionBackend [get, set]
 
bool EncryptionEnabled [get, set]
 
int EphemeralLifetime [get, set]
 
Linphone.ChatRoomEphemeralMode EphemeralMode [get, set]
 
bool GroupEnabled [get, set]
 
bool IsValid [get]
 
bool RttEnabled [get, set]
 
string Subject [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 parameters for a Linphone.ChatRoom.

Can be created with Linphone.Core.CreateDefaultChatRoomParams(). You can use Linphone.ChatRoomParams.IsValid() to check if your configuration is valid or not. 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.

Property Documentation

Linphone.ChatRoomBackend Linphone.ChatRoomParams.Backend
getset

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

Returns
the Linphone.ChatRoomBackend

Deprecated : 20/05/2024. Use Linphone.ChatParams.Backend instead.

Linphone.ChatRoomEncryptionBackend Linphone.ChatRoomParams.EncryptionBackend
getset

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

Returns
the Linphone.ChatRoomEncryptionBackend

Deprecated : 20/05/2024. Use Linphone.ChatParams.EncryptionBackend instead.

bool Linphone.ChatRoomParams.EncryptionEnabled
getset

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 Linphone.ChatParams.EncryptionEnabled() instead.

int Linphone.ChatRoomParams.EphemeralLifetime
getset

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

Returns
the ephemeral lifetime (in seconds)

Deprecated : 20/05/2024. Use Linphone.ChatParams.EphemeralLifetime instead.

Linphone.ChatRoomEphemeralMode Linphone.ChatRoomParams.EphemeralMode
getset

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

Returns
the ephemeral message mode Linphone.ChatRoomEphemeralMode

Deprecated : 20/05/2024. Use Linphone.ChatParams.EphemeralMode instead.

bool Linphone.ChatRoomParams.GroupEnabled
getset

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

Returns
true if group chat is enabled, false if one-on-one

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

bool Linphone.ChatRoomParams.IsValid
get

Returns whether the given parameters are valid or not.

Returns
true if the given parameters are valid, false otherwise

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

bool Linphone.ChatRoomParams.RttEnabled
getset

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 Linphone.ChatParams.RttEnabled() instead.

string Linphone.ChatRoomParams.Subject
getset

Get the subject of the chat room.

Returns
The subject.

Deprecated : 20/05/2024. Use Linphone.ConferenceParams.Subject instead.


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