Chatroom

Functions
const bctbx_list_t *	linphone_core_get_chat_rooms (LinphoneCore *core)
LinphoneChatRoomParams *	linphone_core_create_default_chat_room_params (LinphoneCore *core)
LinphoneImNotifPolicy *	linphone_im_notif_policy_ref (LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_unref (LinphoneImNotifPolicy *policy)
void *	linphone_im_notif_policy_get_user_data (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_user_data (LinphoneImNotifPolicy *policy, void *user_data)
void	linphone_im_notif_policy_clear (LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_enable_all (LinphoneImNotifPolicy *policy)
bool_t	linphone_im_notif_policy_get_send_is_composing (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_send_is_composing (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_recv_is_composing (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_recv_is_composing (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_send_imdn_delivered (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_send_imdn_delivered (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_recv_imdn_delivered (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_recv_imdn_delivered (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_send_imdn_delivery_error (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_send_imdn_delivery_error (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_recv_imdn_delivery_error (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_recv_imdn_delivery_error (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_send_imdn_displayed (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_send_imdn_displayed (LinphoneImNotifPolicy *policy, bool_t enable)
bool_t	linphone_im_notif_policy_get_recv_imdn_displayed (const LinphoneImNotifPolicy *policy)
void	linphone_im_notif_policy_set_recv_imdn_displayed (LinphoneImNotifPolicy *policy, bool_t enable)

Detailed Description

Function Documentation

LinphoneChatRoomParams* linphone_core_create_default_chat_room_params

(

LinphoneCore *

core

)

Creates and returns the default chat room parameters.

Parameters

core	LinphoneCore object

Returns

A LinphoneChatRoomParams object

const bctbx_list_t* linphone_core_get_chat_rooms

(

LinphoneCore *

core

)

Returns a list of chat rooms.

Parameters

core	LinphoneCore object

Returns

List of chat rooms.

void linphone_im_notif_policy_clear

(

LinphoneImNotifPolicy *

policy

)

Clear an IM notif policy (deactivate all receiving and sending of notifications).

Note: Error IMDN must be enabled for Lime recovery mechanism

Parameters

policy

LinphoneImNotifPolicy object.

void linphone_im_notif_policy_enable_all

(

LinphoneImNotifPolicy *

policy

)

Enable all receiving and sending of notifications.

Parameters

policy

LinphoneImNotifPolicy object.

bool_t linphone_im_notif_policy_get_recv_imdn_delivered

(

const LinphoneImNotifPolicy *

policy

)

Tell whether imdn delivered notifications are being notified when received.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether imdn delivered notifications are being notified when received.

bool_t linphone_im_notif_policy_get_recv_imdn_delivery_error

(

const LinphoneImNotifPolicy *

policy

)

Tell whether imdn delivery error notifications are being notified when received.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether imdn delivery error notifications are being notified when received.

bool_t linphone_im_notif_policy_get_recv_imdn_displayed

(

const LinphoneImNotifPolicy *

policy

)

Tell whether imdn displayed notifications are being notified when received.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether imdn displayed notifications are being notified when received.

bool_t linphone_im_notif_policy_get_recv_is_composing

(

const LinphoneImNotifPolicy *

policy

)

Tell whether is_composing notifications are being notified when received.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether is_composing notifications are being notified when received.

bool_t linphone_im_notif_policy_get_send_imdn_delivered

(

const LinphoneImNotifPolicy *

policy

)

Tell whether imdn delivered notifications are being sent.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether imdn delivered notifications are being sent.

bool_t linphone_im_notif_policy_get_send_imdn_delivery_error

(

const LinphoneImNotifPolicy *

policy

)

Tell whether imdn delivery error notifications are being sent.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether imdn delivery error notifications are being sent.

bool_t linphone_im_notif_policy_get_send_imdn_displayed

(

const LinphoneImNotifPolicy *

policy

)

Tell whether imdn displayed notifications are being sent.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether imdn displayed notifications are being sent.

bool_t linphone_im_notif_policy_get_send_is_composing

(

const LinphoneImNotifPolicy *

policy

)

Tell whether is_composing notifications are being sent.

Parameters

policy

LinphoneImNotifPolicy object

Returns

Boolean value telling whether is_composing notifications are being sent.

void* linphone_im_notif_policy_get_user_data

(

const LinphoneImNotifPolicy *

policy

)

Retrieve the user pointer associated with the LinphoneImNotifPolicy object.

Parameters

policy

LinphoneImNotifPolicy object.

Returns

The user pointer associated with the LinphoneImNotifPolicy object.

LinphoneImNotifPolicy* linphone_im_notif_policy_ref

(

LinphoneImNotifPolicy *

policy

)

Acquire a reference to the LinphoneImNotifPolicy object.

Parameters

policy

LinphoneImNotifPolicy object.

Returns

The same LinphoneImNotifPolicy object.

void linphone_im_notif_policy_set_recv_imdn_delivered	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable imdn delivered notifications receiving.

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to notify received imdn delivered notifications.

void linphone_im_notif_policy_set_recv_imdn_delivery_error	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable imdn delivery error notifications receiving.

Note: Error IMDN must be enabled for Lime recovery mechanism

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to notify received imdn delivery error notifications.

void linphone_im_notif_policy_set_recv_imdn_displayed	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable imdn displayed notifications receiving.

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to notify received imdn displayed notifications.

void linphone_im_notif_policy_set_recv_is_composing	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable is_composing notifications receiving.

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to notify received is_composing notifications.

void linphone_im_notif_policy_set_send_imdn_delivered	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable imdn delivered notifications sending.

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to send imdn delivered notifications.

void linphone_im_notif_policy_set_send_imdn_delivery_error	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable imdn delivery error notifications sending.

Note: Error IMDN must be enabled for Lime recovery mechanism

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to send imdn delivery error notifications.

void linphone_im_notif_policy_set_send_imdn_displayed	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable imdn displayed notifications sending.

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to send imdn displayed notifications.

void linphone_im_notif_policy_set_send_is_composing	(	LinphoneImNotifPolicy *	policy,
		bool_t	enable
	)

Enable is_composing notifications sending.

Parameters

policy	LinphoneImNotifPolicy object
enable	Boolean value telling whether to send is_composing notifications.

void linphone_im_notif_policy_set_user_data	(	LinphoneImNotifPolicy *	policy,
		void *	user_data
	)

Assign a user pointer to the LinphoneImNotifPolicy object.

Parameters

policy	LinphoneImNotifPolicy object.
user_data	The user pointer to associate with the LinphoneImNotifPolicy object.

void linphone_im_notif_policy_unref

(

LinphoneImNotifPolicy *

policy

)

Release reference to the LinphoneImNotifPolicy object.

Parameters

policy

LinphoneImNotifPolicy object.