Class ChatRoomParams

Object defining parameters for a ChatRoom.

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

Inheritance

System.Object

LinphoneObject

ChatRoomParams

Inherited Members

LinphoneObject.StringArrayToBctbxList(IEnumerable<String>)

LinphoneObject.CleanStringArrayPtrs()

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 ChatRoomParams : LinphoneObject

Properties

Backend

Get the backend implementation of the chat room 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 chat room associated with the given parameters.

Declaration

public ChatRoomEncryptionBackend EncryptionBackend { get; set; }

Property Value

Type	Description
ChatRoomEncryptionBackend	the ChatRoomEncryptionBackend

EncryptionEnabled

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

Declaration

public bool EncryptionEnabled { get; set; }

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 chat room.

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_room_params_ephemeral_enabled()

EphemeralMode

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

Declaration

public ChatRoomEphemeralMode EphemeralMode { get; set; }

Property Value

Type	Description
ChatRoomEphemeralMode	the ephemeral message mode ChatRoomEphemeralMode

GroupEnabled

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

Declaration

public bool GroupEnabled { get; set; }

Property Value

Type	Description
System.Boolean	true if group chat is enabled, false if one-to-one

IsValid

Returns whether the given parameters are valid or not.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean	true if the given parameters are valid, false otherwise

RttEnabled

Get the real time text status of the chat room 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

Subject

Get the subject of the chat room.

Declaration

public string Subject { get; set; }

Property Value

Type	Description
System.String	The subject.