Liblinphone  5.4.0
Functions
Chatroom

Functions

const bctbx_list_t * linphone_core_get_chat_rooms (LinphoneCore *core)
 Returns a list of chat rooms. More...
 
LinphoneChatRoomParamslinphone_core_create_default_chat_room_params (LinphoneCore *core)
 Creates and returns the default chat room parameters. More...
 
void linphone_core_set_message_sending_delay (LinphoneCore *core, int duration)
 It sets the duration of the timer that starts just after the SUBSCRIBE is sent to delay the sending of chat messages in group chats. More...
 
LinphoneImNotifPolicylinphone_im_notif_policy_ref (LinphoneImNotifPolicy *policy)
 Acquire a reference to the LinphoneImNotifPolicy object. More...
 
void linphone_im_notif_policy_unref (LinphoneImNotifPolicy *policy)
 Release reference to the LinphoneImNotifPolicy object. More...
 
void * linphone_im_notif_policy_get_user_data (const LinphoneImNotifPolicy *policy)
 Retrieve the user pointer associated with the LinphoneImNotifPolicy object. More...
 
void linphone_im_notif_policy_set_user_data (LinphoneImNotifPolicy *policy, void *user_data)
 Assign a user pointer to the LinphoneImNotifPolicy object. More...
 
void linphone_im_notif_policy_clear (LinphoneImNotifPolicy *policy)
 Clear an IM notif policy (deactivate all receiving and sending of notifications). More...
 
void linphone_im_notif_policy_enable_all (LinphoneImNotifPolicy *policy)
 Enable all receiving and sending of notifications. More...
 
bool_t linphone_im_notif_policy_get_send_is_composing (const LinphoneImNotifPolicy *policy)
 Tell whether is_composing notifications are being sent. More...
 
void linphone_im_notif_policy_set_send_is_composing (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable is_composing notifications sending. More...
 
bool_t linphone_im_notif_policy_get_recv_is_composing (const LinphoneImNotifPolicy *policy)
 Tell whether is_composing notifications are being notified when received. More...
 
void linphone_im_notif_policy_set_recv_is_composing (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable is_composing notifications receiving. More...
 
bool_t linphone_im_notif_policy_get_send_imdn_delivered (const LinphoneImNotifPolicy *policy)
 Tell whether imdn delivered notifications are being sent. More...
 
void linphone_im_notif_policy_set_send_imdn_delivered (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable imdn delivered notifications sending. More...
 
bool_t linphone_im_notif_policy_get_recv_imdn_delivered (const LinphoneImNotifPolicy *policy)
 Tell whether imdn delivered notifications are being notified when received. More...
 
void linphone_im_notif_policy_set_recv_imdn_delivered (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable imdn delivered notifications receiving. More...
 
bool_t linphone_im_notif_policy_get_send_imdn_delivery_error (const LinphoneImNotifPolicy *policy)
 Tell whether imdn delivery error notifications are being sent. More...
 
void linphone_im_notif_policy_set_send_imdn_delivery_error (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable imdn delivery error notifications sending. More...
 
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. More...
 
void linphone_im_notif_policy_set_recv_imdn_delivery_error (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable imdn delivery error notifications receiving. More...
 
bool_t linphone_im_notif_policy_get_send_imdn_displayed (const LinphoneImNotifPolicy *policy)
 Tell whether imdn displayed notifications are being sent. More...
 
void linphone_im_notif_policy_set_send_imdn_displayed (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable imdn displayed notifications sending. More...
 
bool_t linphone_im_notif_policy_get_recv_imdn_displayed (const LinphoneImNotifPolicy *policy)
 Tell whether imdn displayed notifications are being notified when received. More...
 
void linphone_im_notif_policy_set_recv_imdn_displayed (LinphoneImNotifPolicy *policy, bool_t enable)
 Enable imdn displayed notifications receiving. More...
 

Detailed Description

Function Documentation

◆ linphone_core_create_default_chat_room_params()

LinphoneChatRoomParams* linphone_core_create_default_chat_room_params ( LinphoneCore core)

Creates and returns the default chat room parameters.

Parameters
coreLinphoneCore object
Returns
A LinphoneChatRoomParams object

◆ linphone_core_get_chat_rooms()

const bctbx_list_t* linphone_core_get_chat_rooms ( LinphoneCore core)

Returns a list of chat rooms.

Parameters
coreLinphoneCore object
Returns
List of chat rooms.

◆ linphone_core_set_message_sending_delay()

void linphone_core_set_message_sending_delay ( LinphoneCore core,
int  duration 
)

It sets the duration of the timer that starts just after the SUBSCRIBE is sent to delay the sending of chat messages in group chats.

Parameters
coreLinphoneCore object
durationthe duration of the timer in seconds.
Warning
it is only useful to set this property if linphone_core_send_message_after_notify_enabled returns false

◆ linphone_im_notif_policy_clear()

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
policyLinphoneImNotifPolicy object.

◆ linphone_im_notif_policy_enable_all()

void linphone_im_notif_policy_enable_all ( LinphoneImNotifPolicy policy)

Enable all receiving and sending of notifications.

Parameters
policyLinphoneImNotifPolicy object.

◆ linphone_im_notif_policy_get_recv_imdn_delivered()

bool_t linphone_im_notif_policy_get_recv_imdn_delivered ( const LinphoneImNotifPolicy policy)

Tell whether imdn delivered notifications are being notified when received.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether imdn delivered notifications are being notified when received.

◆ linphone_im_notif_policy_get_recv_imdn_delivery_error()

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
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether imdn delivery error notifications are being notified when received.

◆ linphone_im_notif_policy_get_recv_imdn_displayed()

bool_t linphone_im_notif_policy_get_recv_imdn_displayed ( const LinphoneImNotifPolicy policy)

Tell whether imdn displayed notifications are being notified when received.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether imdn displayed notifications are being notified when received.

◆ linphone_im_notif_policy_get_recv_is_composing()

bool_t linphone_im_notif_policy_get_recv_is_composing ( const LinphoneImNotifPolicy policy)

Tell whether is_composing notifications are being notified when received.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether is_composing notifications are being notified when received.

◆ linphone_im_notif_policy_get_send_imdn_delivered()

bool_t linphone_im_notif_policy_get_send_imdn_delivered ( const LinphoneImNotifPolicy policy)

Tell whether imdn delivered notifications are being sent.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether imdn delivered notifications are being sent.

◆ linphone_im_notif_policy_get_send_imdn_delivery_error()

bool_t linphone_im_notif_policy_get_send_imdn_delivery_error ( const LinphoneImNotifPolicy policy)

Tell whether imdn delivery error notifications are being sent.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether imdn delivery error notifications are being sent.

◆ linphone_im_notif_policy_get_send_imdn_displayed()

bool_t linphone_im_notif_policy_get_send_imdn_displayed ( const LinphoneImNotifPolicy policy)

Tell whether imdn displayed notifications are being sent.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether imdn displayed notifications are being sent.

◆ linphone_im_notif_policy_get_send_is_composing()

bool_t linphone_im_notif_policy_get_send_is_composing ( const LinphoneImNotifPolicy policy)

Tell whether is_composing notifications are being sent.

Parameters
policyLinphoneImNotifPolicy object
Returns
Boolean value telling whether is_composing notifications are being sent.

◆ linphone_im_notif_policy_get_user_data()

void* linphone_im_notif_policy_get_user_data ( const LinphoneImNotifPolicy policy)

Retrieve the user pointer associated with the LinphoneImNotifPolicy object.

Parameters
policyLinphoneImNotifPolicy object.
Returns
The user pointer associated with the LinphoneImNotifPolicy object.

◆ linphone_im_notif_policy_ref()

LinphoneImNotifPolicy* linphone_im_notif_policy_ref ( LinphoneImNotifPolicy policy)

Acquire a reference to the LinphoneImNotifPolicy object.

Parameters
policyLinphoneImNotifPolicy object.
Returns
The same LinphoneImNotifPolicy object.

◆ linphone_im_notif_policy_set_recv_imdn_delivered()

void linphone_im_notif_policy_set_recv_imdn_delivered ( LinphoneImNotifPolicy policy,
bool_t  enable 
)

Enable imdn delivered notifications receiving.

Parameters
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to notify received imdn delivered notifications.

◆ linphone_im_notif_policy_set_recv_imdn_delivery_error()

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
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to notify received imdn delivery error notifications.

◆ linphone_im_notif_policy_set_recv_imdn_displayed()

void linphone_im_notif_policy_set_recv_imdn_displayed ( LinphoneImNotifPolicy policy,
bool_t  enable 
)

Enable imdn displayed notifications receiving.

Parameters
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to notify received imdn displayed notifications.

◆ linphone_im_notif_policy_set_recv_is_composing()

void linphone_im_notif_policy_set_recv_is_composing ( LinphoneImNotifPolicy policy,
bool_t  enable 
)

Enable is_composing notifications receiving.

Parameters
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to notify received is_composing notifications.

◆ linphone_im_notif_policy_set_send_imdn_delivered()

void linphone_im_notif_policy_set_send_imdn_delivered ( LinphoneImNotifPolicy policy,
bool_t  enable 
)

Enable imdn delivered notifications sending.

Parameters
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to send imdn delivered notifications.

◆ linphone_im_notif_policy_set_send_imdn_delivery_error()

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
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to send imdn delivery error notifications.

◆ linphone_im_notif_policy_set_send_imdn_displayed()

void linphone_im_notif_policy_set_send_imdn_displayed ( LinphoneImNotifPolicy policy,
bool_t  enable 
)

Enable imdn displayed notifications sending.

Parameters
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to send imdn displayed notifications.

◆ linphone_im_notif_policy_set_send_is_composing()

void linphone_im_notif_policy_set_send_is_composing ( LinphoneImNotifPolicy policy,
bool_t  enable 
)

Enable is_composing notifications sending.

Parameters
policyLinphoneImNotifPolicy object
enableBoolean value telling whether to send is_composing notifications.

◆ linphone_im_notif_policy_set_user_data()

void linphone_im_notif_policy_set_user_data ( LinphoneImNotifPolicy policy,
void *  user_data 
)

Assign a user pointer to the LinphoneImNotifPolicy object.

Parameters
policyLinphoneImNotifPolicy object.
user_dataThe user pointer to associate with the LinphoneImNotifPolicy object.

◆ linphone_im_notif_policy_unref()

void linphone_im_notif_policy_unref ( LinphoneImNotifPolicy policy)

Release reference to the LinphoneImNotifPolicy object.

Parameters
policyLinphoneImNotifPolicy object.