Class ChatParams

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.

Inheritance

System.Object

LinphoneObject

ChatParams

Inherited Members

LinphoneObject.linphone_pointer_to_string(IntPtr)

LinphoneObject.linphone_string_to_pointer(String)

LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)

LinphoneObject.CleanStringArrayPtrs(IntPtr)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Linphone

Assembly: cs.temp.dll.dll

Syntax

public class ChatParams : LinphoneObject

Properties

Backend

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

Declaration

public ChatRoomBackend Backend { get; set; }

Property Value

Type	Description
ChatRoomBackend	the Linphone.ChatRoomBackend

EncryptionBackend

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

Declaration

public ChatRoomEncryptionBackend EncryptionBackend { get; set; }

Property Value

Type	Description
ChatRoomEncryptionBackend	the Linphone.ChatRoomEncryptionBackend

EncryptionEnabled

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

Declaration

public bool EncryptionEnabled { get; }

Property Value

Type	Description
System.Boolean	true if encryption is enabled, false otherwise

EphemeralLifetime

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.

Declaration

[Obsolete]
public int EphemeralLifetime { get; set; }

Property Value

Type	Description
System.Int32	the ephemeral lifetime (in seconds)

Remarks

See : linphone_chat_room_activate_ephemeral()

EphemeralMode

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

Declaration

public ChatRoomEphemeralMode EphemeralMode { get; set; }

Property Value

Type	Description
ChatRoomEphemeralMode	the ephemeral message mode Linphone.ChatRoomEphemeralMode

EphemeralNotReadLifetime

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.

Declaration

public int EphemeralNotReadLifetime { get; }

Property Value

Type	Description
System.Int32	The ephemeral not read lifetime (in seconds)

Remarks

See : linphone_chat_room_activate_ephemeral_2()

RttEnabled

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

Declaration

public bool RttEnabled { get; set; }

Property Value

Type	Description
System.Boolean	true if real time text is enabled, false otherwise

Methods

ActivateEphemeral(UInt32)

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 Linphone.Core.DefaultEphemeralNotReadLifetime if it is never specified. When still not read, it will be deleted after "notReadLifetime" seconds to avoid being persistent.

Declaration

public void ActivateEphemeral(uint lifetime)

Parameters

Type	Name	Description
System.UInt32	lifetime	The ephemeral lifetime, strictly positive

Remarks

See : linphone_chat_room_activate_ephemeral()

ActivateEphemeral(UInt32, UInt32)

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.

Declaration

public void ActivateEphemeral(uint lifetime, uint notReadLifetime)

Parameters

Type	Name	Description
System.UInt32	lifetime	The ephemeral lifetime, strictly positive
System.UInt32	notReadLifetime	The ephemeral not read lifetime, strictly positive

Remarks

See : linphone_chat_room_activate_ephemeral()

Clone()

Clone a Linphone.ChatParams.

Declaration

public ChatParams Clone()

Returns

Type	Description
ChatParams	An allocated Linphone.ChatParams with the same parameters than params @notnil

DeactivateEphemeral()

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

Declaration

public void DeactivateEphemeral()

Remarks

See : Linphone.ChatRoom.DeactivateEphemeral()