Class ChatParams
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 Basic, then no other parameter is required, but ChatMessage sent and received won't benefit from all features a 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.
Inherited Members
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 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 |
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 "time" seconds.
Declaration
public int EphemeralLifetime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 | the ephemeral lifetime (in seconds) |
Remarks
See : linphone_chat_params_ephemeral_enabled()
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 ChatRoomEphemeralMode |
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
Clone()
Clone a ChatParams.
Declaration
public ChatParams Clone()
Returns
| Type | Description |
|---|---|
| ChatParams | An allocated ChatParams with the same parameters than params |