Liblinphone
5.3.0
|
Object defining parameters for a ChatRoom. More...
#include <chat_room_params.hh>
Public Member Functions | |
LINPHONECXX_PUBLIC | ChatRoomParams (void *ptr, bool takeRef=true) |
LINPHONECXX_PUBLIC _LinphoneChatRoomParams * | cPtr () |
LINPHONECXX_PUBLIC linphone::ChatRoom::Backend | getBackend () const |
Get the backend implementation of the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC void | setBackend (linphone::ChatRoom::Backend backend) |
Set the backend implementation of these chat room parameters. More... | |
LINPHONECXX_PUBLIC linphone::ChatRoom::EncryptionBackend | getEncryptionBackend () const |
Get the encryption implementation of the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC void | setEncryptionBackend (linphone::ChatRoom::EncryptionBackend backend) |
Set the encryption backend implementation of these chat room parameters. More... | |
LINPHONECXX_PUBLIC bool | encryptionEnabled () const |
Get the encryption status of the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC void | enableEncryption (bool encrypted) |
Enables or disables encryption for the chat room associated with the given parameters. | |
LINPHONECXX_PUBLIC long | getEphemeralLifetime () const |
Get lifetime (in seconds) for all new ephemeral messages in the chat room. More... | |
LINPHONECXX_PUBLIC void | setEphemeralLifetime (long time) |
Set lifetime (in seconds) for all new ephemral messages in the chat room. More... | |
LINPHONECXX_PUBLIC linphone::ChatRoom::EphemeralMode | getEphemeralMode () const |
Get the ephemeral message mode of the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC void | setEphemeralMode (linphone::ChatRoom::EphemeralMode mode) |
Enables or disables forcing of ephemeral messages for the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC bool | groupEnabled () const |
Get the group chat status of the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC void | enableGroup (bool group) |
Enables or disables group chat for the chat room associated with the given parameters. | |
LINPHONECXX_PUBLIC bool | isValid () const |
Returns whether the given parameters are valid or not. More... | |
LINPHONECXX_PUBLIC bool | rttEnabled () const |
Get the real time text status of the chat room associated with the given parameters. More... | |
LINPHONECXX_PUBLIC void | enableRtt (bool rtt) |
Enables or disables real time text for the chat room associated with the given parameters. | |
LINPHONECXX_PUBLIC std::string | getSubject () const |
Get the subject of the chat room. More... | |
LINPHONECXX_PUBLIC void | setSubject (const std::string &subject) |
Set the subject of the chat room. More... | |
Object defining parameters for a ChatRoom.
Can be created with Core::createDefaultChatRoomParams(). You can use isValid() to check if your configuration is valid or not. If the ChatRoom backend is ChatRoom::Backend::Basic, then no other parameter is required, but ChatMessage sent and received won't benefit from all features a ChatRoom::Backend::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.
LINPHONECXX_PUBLIC bool linphone::ChatRoomParams::encryptionEnabled | ( | ) | const |
Get the encryption status of the chat room associated with the given parameters.
LINPHONECXX_PUBLIC linphone::ChatRoom::Backend linphone::ChatRoomParams::getBackend | ( | ) | const |
Get the backend implementation of the chat room associated with the given parameters.
LINPHONECXX_PUBLIC linphone::ChatRoom::EncryptionBackend linphone::ChatRoomParams::getEncryptionBackend | ( | ) | const |
Get the encryption implementation of the chat room associated with the given parameters.
LINPHONECXX_PUBLIC long linphone::ChatRoomParams::getEphemeralLifetime | ( | ) | const |
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.
LINPHONECXX_PUBLIC linphone::ChatRoom::EphemeralMode linphone::ChatRoomParams::getEphemeralMode | ( | ) | const |
Get the ephemeral message mode of the chat room associated with the given parameters.
LINPHONECXX_PUBLIC std::string linphone::ChatRoomParams::getSubject | ( | ) | const |
Get the subject of the chat room.
LINPHONECXX_PUBLIC bool linphone::ChatRoomParams::groupEnabled | ( | ) | const |
Get the group chat status of the chat room associated with the given parameters.
LINPHONECXX_PUBLIC bool linphone::ChatRoomParams::isValid | ( | ) | const |
Returns whether the given parameters are valid or not.
LINPHONECXX_PUBLIC bool linphone::ChatRoomParams::rttEnabled | ( | ) | const |
Get the real time text status of the chat room associated with the given parameters.
LINPHONECXX_PUBLIC void linphone::ChatRoomParams::setBackend | ( | linphone::ChatRoom::Backend | backend | ) |
Set the backend implementation of these chat room parameters.
backend | The ChatRoom::Backend enum value |
LINPHONECXX_PUBLIC void linphone::ChatRoomParams::setEncryptionBackend | ( | linphone::ChatRoom::EncryptionBackend | backend | ) |
Set the encryption backend implementation of these chat room parameters.
backend | The ChatRoom::EncryptionBackend enum value |
LINPHONECXX_PUBLIC void linphone::ChatRoomParams::setEphemeralLifetime | ( | long | time | ) |
Set lifetime (in seconds) for all new ephemral messages in the chat room.
After the message is read, it will be deleted after "time" seconds.
time | The ephemeral lifetime, default is disabled (0) |
LINPHONECXX_PUBLIC void linphone::ChatRoomParams::setEphemeralMode | ( | linphone::ChatRoom::EphemeralMode | mode | ) |
Enables or disables forcing of ephemeral messages for the chat room associated with the given parameters.
mode | Ephemeral message mode ChatRoom::EphemeralMode. |
LINPHONECXX_PUBLIC void linphone::ChatRoomParams::setSubject | ( | const std::string & | subject | ) |
Set the subject of the chat room.
subject | The subject to set. |