chenqiyang
2022-09-02 6a99d9bf65aa5878cb409945ed2bdbdcb916d047
Shared.IOS.HDLLinphoneSDK/Shared.IOS.HDLLinphoneSDK/Library/linphone.framework/Headers/api/c-chat-room-params.h
old mode 100644 new mode 100755
@@ -39,95 +39,111 @@
**/
LINPHONE_PUBLIC LinphoneChatRoomParams *linphone_chat_room_params_new(void);
LinphoneChatRoomParams *linphone_chat_room_params_clone(const LinphoneChatRoomParams *params);
/**
 * Acquire a reference to the chat room parameters.
 * @param[in] params The chat room parameters.
 * @return The same chat room parameters.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return The same #LinphoneChatRoomParams object. @notnil
**/
LINPHONE_PUBLIC LinphoneChatRoomParams *linphone_chat_room_params_ref(LinphoneChatRoomParams *params);
/**
 * Release reference to the chat room params.
 * @param[in] params The chat room params.
 * @param params The #LinphoneChatRoomParams object. @notnil
**/
LINPHONE_PUBLIC void linphone_chat_room_params_unref(LinphoneChatRoomParams *params);
/**
 * @param[in] params The chat room params.
 * Returns whether the given parameters are valid or not.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return TRUE if the given parameters are valid, FALSE otherwise
 **/
LINPHONE_PUBLIC bool_t linphone_chat_room_params_is_valid(const LinphoneChatRoomParams *params);
/**
 * Get the backend implementation of the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @return LinphoneChatRoomBackend
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return the #LinphoneChatRoomBackend
**/
LINPHONE_PUBLIC LinphoneChatRoomBackend linphone_chat_room_params_get_backend(const LinphoneChatRoomParams *params);
/**
 * Get the encryption implementation of the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @return LinphoneChatRoomEncryptionBackend
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return the #LinphoneChatRoomEncryptionBackend
**/
LINPHONE_PUBLIC LinphoneChatRoomEncryptionBackend linphone_chat_room_params_get_encryption_backend(const LinphoneChatRoomParams *params);
/**
 * Get the group chat status of the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return TRUE if group chat is enabled, FALSE if one-to-one
**/
LINPHONE_PUBLIC bool_t linphone_chat_room_params_group_enabled(const LinphoneChatRoomParams *params);
/**
 * Get the encryption status of the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return TRUE if encryption is enabled, FALSE otherwise
**/
LINPHONE_PUBLIC bool_t linphone_chat_room_params_encryption_enabled(const LinphoneChatRoomParams *params);
/**
 * Get the real time text status of the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return TRUE if real time text is enabled, FALSE otherwise
**/
LINPHONE_PUBLIC bool_t linphone_chat_room_params_rtt_enabled(const LinphoneChatRoomParams *params);
/**
 * Set the backend implementation of these chat room parameters.
 * @param[in] params The chat room params.
 * @param[in] backend The #LinphoneChatRoomBackend enum value
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @param backend The #LinphoneChatRoomBackend enum value
**/
LINPHONE_PUBLIC void linphone_chat_room_params_set_backend(LinphoneChatRoomParams *params, LinphoneChatRoomBackend backend);
/**
 * Set the encryption backend implementation of these chat room parameters.
 * @param[in] params The chat room params.
 * @param[in] backend The #LinphoneChatRoomEncryptionBackend enum value
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @param backend The #LinphoneChatRoomEncryptionBackend enum value
**/
LINPHONE_PUBLIC void linphone_chat_room_params_set_encryption_backend(LinphoneChatRoomParams *params, LinphoneChatRoomEncryptionBackend backend);
/**
 * Enables or disables group chat for the chat room associated with the given parameters.
 * @param[in] cr The chat room params.
 * @param[in] group. TRUE to enable group chat, FALSE to disable (resulting in one-to-one chat room)
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @param group. TRUE to enable group chat, FALSE to disable (resulting in one-to-one chat room)
 **/
LINPHONE_PUBLIC void linphone_chat_room_params_enable_group(LinphoneChatRoomParams *params, bool_t group);
/**
 * Enables or disables encryption for the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @param[in] encrypted. TRUE to enable encryption, FALSE to disable.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @param encrypted. TRUE to enable encryption, FALSE to disable.
**/
LINPHONE_PUBLIC void linphone_chat_room_params_enable_encryption(LinphoneChatRoomParams *params, bool_t encrypted);
/**
 * Enables or disables real time text for the chat room associated with the given parameters.
 * @param[in] params The chat room params.
 * @param[in] rtt. TRUE to enable real time text, FALSE to disable.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @param rtt. TRUE to enable real time text, FALSE to disable.
**/
LINPHONE_PUBLIC void linphone_chat_room_params_enable_rtt(LinphoneChatRoomParams *params, bool_t rtt);
/**
 * Get the subject of the chat room.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @return The subject. @maybenil
**/
LINPHONE_PUBLIC const char * linphone_chat_room_params_get_subject(LinphoneChatRoomParams *params);
/**
 * Set the subject of the chat room.
 * @param params The #LinphoneChatRoomParams object. @notnil
 * @param subject The subject to set. @maybenil
**/
LINPHONE_PUBLIC void linphone_chat_room_params_set_subject(LinphoneChatRoomParams *params, const char *subject);
/**
 * @}