|
Liblinphone 5.5.0
|
Instant messaging.
| typedef struct _LinphoneChatMessage LinphoneChatMessage |
A LinphoneChatMessage represents an instant message that can be send or received through a LinphoneChatRoom.
To create a LinphoneChatMessage, use linphone_chat_room_create_empty_message(), then either add text using linphone_chat_message_add_utf8_text_content() or a LinphoneContent with file informations using linphone_chat_message_add_file_content(). A valid LinphoneContent for file transfer must contain a type and subtype, the name of the file and it's size. Finally call linphone_chat_message_send() to send it.
To send files through a LinphoneChatMessage, you need to have configured a file transfer server URL with linphone_core_set_file_transfer_server(). On the receiving side, either use linphone_chat_message_download_content() to download received files or enable auto-download in the LinphoneCore using linphone_core_set_max_size_for_auto_download_incoming_files(), -1 disabling the feature and 0 always downloading files no matter it's size.
Keep in mind a LinphoneChatMessage created by a LinphoneChatRoomBackendBasic LinphoneChatRoom can only contain one LinphoneContent, either text or file.
| typedef void(* LinphoneChatMessageCbsContentEditedCb) (LinphoneChatMessage *message) |
Callback used to notify a message has been edited by it's sender after it was sent.
| message | LinphoneChatMessage object that has been edited |
| typedef void(* LinphoneChatMessageCbsEphemeralMessageDeletedCb) (LinphoneChatMessage *message) |
Call back used to notify ephemeral message is deleted.
| message | LinphoneChatMessage object |
| typedef void(* LinphoneChatMessageCbsEphemeralMessageTimerStartedCb) (LinphoneChatMessage *message) |
Callback used to notify an ephemeral message that its lifespan before disappearing has started to decrease.
This callback is called when the ephemeral message is read by the receiver.
| message | LinphoneChatMessage object |
| typedef void(* LinphoneChatMessageCbsFileTransferProgressIndicationCb) (LinphoneChatMessage *message, LinphoneContent *content, size_t offset, size_t total) |
File transfer progress indication callback prototype.
| message | LinphoneChatMessage message from which the body is received. |
| content | LinphoneContent incoming content information |
| offset | The number of bytes sent/received since the beginning of the transfer. |
| total | The total number of bytes to be sent/received. |
| typedef void(* LinphoneChatMessageCbsFileTransferRecvCb) (LinphoneChatMessage *message, LinphoneContent *content, const LinphoneBuffer *buffer) |
File transfer receive callback prototype.
This function is called by the core upon an incoming File transfer is started. This function may be call several time for the same file in case of large file.
| message | LinphoneChatMessage message from which the body is received. |
| content | LinphoneContent incoming content information |
| buffer | LinphoneBuffer holding the received data. Empty buffer means end of file. |
| typedef LinphoneBuffer *(* LinphoneChatMessageCbsFileTransferSendCb) (LinphoneChatMessage *message, LinphoneContent *content, size_t offset, size_t size) |
File transfer send callback prototype.
This function is called by the core when an outgoing file transfer is started. This function is called until size is set to 0.
| message | LinphoneChatMessage message from which the body is received. |
| content | LinphoneContent outgoing content |
| offset | the offset in the file from where to get the data to be sent |
| size | the number of bytes expected by the framework |
| typedef void(* LinphoneChatMessageCbsFileTransferSendChunkCb) (LinphoneChatMessage *message, LinphoneContent *content, size_t offset, size_t size, LinphoneBuffer *buffer) |
File transfer send callback prototype.
This function is called by the core when an outgoing file transfer is started. This function is called until size is set to 0.
| message | LinphoneChatMessage message from which the body is received. |
| content | LinphoneContent outgoing content |
| offset | the offset in the file from where to get the data to be sent |
| size | the number of bytes expected by the framework |
| buffer | A LinphoneBuffer to be filled. Leave it empty when end of file has been reached. |
| typedef void(* LinphoneChatMessageCbsFileTransferTerminatedCb) (LinphoneChatMessage *message, LinphoneContent *content) |
File transfer terminated callback prototype.
| message | LinphoneChatMessage message from which the body is received. |
| content | LinphoneContent incoming content information |
| typedef void(* LinphoneChatMessageCbsMsgStateChangedCb) (LinphoneChatMessage *message, LinphoneChatMessageState state) |
Call back used to notify message delivery status.
| message | LinphoneChatMessage object |
| state | LinphoneChatMessageState |
| typedef void(* LinphoneChatMessageCbsNewMessageReactionCb) (LinphoneChatMessage *message, const LinphoneChatMessageReaction *reaction) |
Callback used to notify a reaction has been received or sent for a given message.
| message | LinphoneChatMessage object |
| reaction | the LinphoneChatMessageReaction reaction that was sent or received |
| typedef void(* LinphoneChatMessageCbsParticipantImdnStateChangedCb) (LinphoneChatMessage *message, const LinphoneParticipantImdnState *state) |
Call back used to notify participant IMDN state.
| message | LinphoneChatMessage object |
| state | LinphoneParticipantImdnState |
| typedef void(* LinphoneChatMessageCbsReactionRemovedCb) (LinphoneChatMessage *message, const LinphoneAddress *address) |
Callback used to notify a reaction has been removed from a given message.
| message | LinphoneChatMessage object |
| address | the LinphoneAddress of the person that removed it's reaction |
| typedef void(* LinphoneChatMessageCbsRetractedCb) (LinphoneChatMessage *message) |
Callback used to notify a message has been retracted by it's sender after it was sent.
| message | LinphoneChatMessage object that has been edited |
| typedef struct _LinphoneChatMessageReaction LinphoneChatMessageReaction |
A chat message reaction is an emoji sent by someone in the same chat room to react to a specific LinphoneChatMessage.
To create a LinphoneChatMessageReaction, use linphone_chat_message_create_reaction(). Once you are ready, send the reaction using linphone_chat_message_reaction_send().
Reactions are available using linphone_chat_message_get_reactions() and will be notified using dedicated callbacks either in LinphoneCoreCbs or LinphoneChatMessageCbs.
| typedef void(* LinphoneChatMessageStateChangedCb) (LinphoneChatMessage *message, LinphoneChatMessageState state, void *user_data) |
Call back used to notify message delivery status.
| message | LinphoneChatMessage object |
| state | LinphoneChatMessageState |
| user_data | application user data |
| typedef struct _LinphoneChatParams LinphoneChatParams |
Object defining settings strictly associated with LinphoneChatRoom objects such as ephemeral settings and backends.
It is automatically created when you enable chat capabilities in the LinphoneConferenceParams.
If the LinphoneChatRoom backend is LinphoneChatRoomBackendBasic, then no other parameter is required, but LinphoneChatMessage sent and received won't benefit from all features a LinphoneChatRoomBackendFlexisipChat 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.
| typedef struct _LinphoneChatRoom LinphoneChatRoom |
A chat room is the place where LinphoneChatMessage are exchanged.
To create (or find) a LinphoneChatRoom, you first need a LinphoneChatRoomParams object. A chat room is uniquely identified by it's local and remote SIP addresses, meaning you can only have one chat room between two accounts (unless the backend is LinphoneChatRoomBackendFlexisipChat). Then you can call linphone_core_search_chat_room() or linphone_core_create_chat_room_6().
Be careful as a LinphoneChatRoomBackendFlexisipChat backend LinphoneChatRoom will be created asynchronously, so make sure you add a LinphoneChatRoomCbs to the returned object to be notified when it will be in state LinphoneChatRoomStateCreated.
All chat rooms are loaded from database when the LinphoneCore starts, and you can get them using linphone_core_get_chat_rooms(). This method doesn't return empty chat rooms nor ones for which the local address doesn't match an existing LinphoneAccount identity, unless you specify otherwise in the [misc] section of your configuration file by setting hide_empty_chat_rooms=0 and/or hide_chat_rooms_from_removed_proxies=0.
| typedef struct _LinphoneChatRoomCbs LinphoneChatRoomCbs |
An object to handle the callbacks for the handling a LinphoneChatRoom objects.
Use linphone_factory_create_chat_room_cbs() to create an instance. Then pass the object to a LinphoneChatRoom instance through linphone_chat_room_add_callbacks().
| typedef void(* LinphoneChatRoomCbsChatMessageParticipantImdnStateChangedCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message, const LinphoneParticipantImdnState *state) |
Callback used to notify a participant state has changed in a message of this chat room.
| chat_room | LinphoneChatRoom object |
| message | The LinphoneChatMessage for which a participant has it's state changed |
| state | The LinphoneParticipantImdnState |
| typedef void(* LinphoneChatRoomCbsChatMessageReceivedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a chat message has been received.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsChatMessageSendingCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a chat message is being sent.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsChatMessageSentCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a chat message has been sent.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsChatMessagesReceivedCb) (LinphoneChatRoom *chat_room, const bctbx_list_t *event_logs) |
Callback used to notify a chat room that one or many chat messages have been received.
Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled()), it replaces the single chat message received callback.
| chat_room | LinphoneChatRoom object |
| event_logs | The list of events to be notified |
| typedef void(* LinphoneChatRoomCbsChatRoomReadCb) (LinphoneChatRoom *chat_room) |
Callback used to notify a chat room was "marked as read".
| chat_room | The LinphoneChatRoom object that was marked as read |
| typedef void(* LinphoneChatRoomCbsConferenceAddressGenerationCb) (LinphoneChatRoom *chat_room) |
Callback used when a group chat room is created server-side to generate the address of the chat room.
The function linphone_chat_room_set_conference_address() needs to be called by this callback.
| chat_room | LinphoneChatRoom object |
| typedef void(* LinphoneChatRoomCbsConferenceJoinedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room has been joined.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsConferenceLeftCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room has been left.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsEphemeralEventCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that an ephemeral related event has been generated.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsEphemeralMessageDeletedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that an ephemeral message has been deleted.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsEphemeralMessageTimerStartedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that the lifespan of an ephemeral message before disappearing has started to decrease.
This callback is called when the ephemeral message is read by the receiver.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsIsComposingReceivedCb) (LinphoneChatRoom *chat_room, const LinphoneAddress *remote_address, bool_t is_composing) |
Is composing notification callback prototype.
| chat_room | LinphoneChatRoom involved in the conversation |
| remote_address | The LinphoneAddress that has sent the is-composing notification |
| is_composing | A boolean value telling whether the remote is composing or not |
| typedef void(* LinphoneChatRoomCbsMessageContentEditedCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message) |
Callback used to notify a message has been edited after being sent or received.
| chat_room | LinphoneChatRoom object |
| message | LinphoneChatMessage object that has been edited |
| typedef void(* LinphoneChatRoomCbsMessageEarlyFailureCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a message has been not sent because of a chat room error.
| chat_room | LinphoneChatRoom involved in this conversation |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsMessageReceivedCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message) |
Callback used to notify a chat room that a message has been received.
| chat_room | LinphoneChatRoom object |
| message | The LinphoneChatMessage that has been received |
| typedef void(* LinphoneChatRoomCbsMessageRetractedCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message) |
Callback used to notify a message has been retracted after being sent or received.
| chat_room | LinphoneChatRoom object |
| message | LinphoneChatMessage object that has been retracted |
| typedef void(* LinphoneChatRoomCbsMessagesReceivedCb) (LinphoneChatRoom *chat_room, const bctbx_list_t *chat_messages) |
Callback used to notify a chat room that many chat messages have been received.
Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled()), it replaces the single message received callback.
| chat_room | LinphoneChatRoom object |
| chat_messages | The list of events to be notified |
| typedef void(* LinphoneChatRoomCbsNewEventCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that an event log has been created.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsNewEventsCb) (LinphoneChatRoom *chat_room, const bctbx_list_t *event_logs) |
Callback used to notify a chat room that many event logs have been created.
| chat_room | LinphoneChatRoom object |
| event_logs | The list of events to be notified |
| typedef void(* LinphoneChatRoomCbsNewMessageReactionCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message, const LinphoneChatMessageReaction *reaction) |
Callback used to notify a reaction has been received or sent for a given message.
| chat_room | LinphoneChatRoom object |
| message | LinphoneChatMessage object for which we received a reaction |
| reaction | the LinphoneChatMessageReaction reaction that was sent or received |
| typedef void(* LinphoneChatRoomCbsOperationFailedCb) (LinphoneChatRoom *chat_room) |
Callback used to notify a chat room exit failed.
| chat_room | LinphoneChatRoom object |
| typedef void(* LinphoneChatRoomCbsParticipantAddedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a participant has been added.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsParticipantAdminStatusChangedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that the admin status of a participant has been changed.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsParticipantDeviceAddedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a participant has been added.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsParticipantDeviceMediaAvailabilityChangedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a conference that the media availability of a participant device has been changed.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsParticipantDeviceRemovedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a participant has been removed.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsParticipantDeviceStateChangedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log, const LinphoneParticipantDeviceState state) |
Callback used to notify a conference that a participant device has changed state.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| state | new participant device state |
| typedef void(* LinphoneChatRoomCbsParticipantRegistrationSubscriptionRequestedCb) (LinphoneChatRoom *chat_room, const LinphoneAddress *participant_address) |
Callback used when a group chat room server is subscribing to registration state of a participant.
| chat_room | LinphoneChatRoom object |
| participant_address | LinphoneAddress object |
| typedef void(* LinphoneChatRoomCbsParticipantRegistrationUnsubscriptionRequestedCb) (LinphoneChatRoom *chat_room, const LinphoneAddress *participant_address) |
Callback used when a group chat room server is unsubscribing to registration state of a participant.
| chat_room | LinphoneChatRoom object |
| participant_address | LinphoneAddress object |
| typedef void(* LinphoneChatRoomCbsParticipantRemovedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a chat room that a participant has been removed.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsSecurityEventCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify a security event in the chat room.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsShouldChatMessageBeStoredCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message) |
Callback used to tell the core whether or not to store the incoming message in db or not using linphone_chat_message_set_to_be_stored().
| chat_room | LinphoneChatRoom object |
| message | The LinphoneChatMessage that is being received |
| typedef void(* LinphoneChatRoomCbsStateChangedCb) (LinphoneChatRoom *chat_room, LinphoneChatRoomState newState) |
Callback used to notify a chat room state has changed.
| chat_room | LinphoneChatRoom object |
| newState | The new LinphoneChatRoomState of the chat room |
| typedef void(* LinphoneChatRoomCbsSubjectChangedCb) (LinphoneChatRoom *chat_room, const LinphoneEventLog *event_log) |
Callback used to notify that the subject of a chat room has changed.
| chat_room | LinphoneChatRoom object |
| event_log | LinphoneEventLog The event to be notified |
| typedef void(* LinphoneChatRoomCbsUndecryptableMessageReceivedCb) (LinphoneChatRoom *chat_room, LinphoneChatMessage *message) |
Callback used to notify a chat room that a message has been received but we were unable to decrypt it.
| chat_room | LinphoneChatRoom involved in this conversation |
| message | The LinphoneChatMessage that has been received |
| typedef struct _LinphoneConferenceParams LinphoneChatRoomParams |
Object defining parameters for a LinphoneChatRoom.
Can be created with linphone_core_create_default_chat_room_params(). You can use linphone_chat_room_params_is_valid() to check if your configuration is valid or not.
If the LinphoneChatRoom backend is LinphoneChatRoomBackendBasic, then no other parameter is required, but LinphoneChatMessage sent and received won't benefit from all features a LinphoneChatRoomBackendFlexisipChat 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.
Ephemeral chat message policies.
This enum represents different policies for managing ephemeral chat message lifetimes.
| typedef struct _LinphoneImNotifPolicy LinphoneImNotifPolicy |
Policy to use to send/receive instant messaging composing/delivery/display notifications.
The sending of this information is done as in the RFCs 3994 (is_composing) and 5438 (imdn delivered/displayed).
| typedef struct _LinphonePushNotificationMessage LinphonePushNotificationMessage |
Object holding chat message data received by a push notification on iOS platform only.
This object is a subset of LinphoneChatMessage, so only a few methods of it's parent are available, like linphone_push_notification_message_get_text_content() and linphone_push_notification_message_get_subject(), just enough to be able to build a notification to show the user.
LinphoneChatMessageDirection is used to indicate if a message is outgoing or incoming.
| Enumerator | |
|---|---|
| LinphoneChatMessageDirectionIncoming | Incoming message. |
| LinphoneChatMessageDirectionOutgoing | Outgoing message. |
LinphoneChatMessageState is used to notify if messages have been successfully delivered or not.
LinphoneChatRoomBackend is used to indicate the backend implementation of a chat room.
| Enumerator | |
|---|---|
| LinphoneChatRoomBackendBasic | Basic (client-to-client) chat room. |
| LinphoneChatRoomBackendFlexisipChat | Server-based chat room. |
LinphoneChatRoomCapabilities is used to indicate the capabilities of a chat room.
LinphoneChatRoomEncryptionBackend is used to indicate the encryption engine used by a chat room.
| Enumerator | |
|---|---|
| LinphoneChatRoomEncryptionBackendNone | No encryption. |
| LinphoneChatRoomEncryptionBackendLime | Lime x3dh encryption. |
LinphoneChatRoomEphemeralMode is used to the ephemeral message mode used by a chat room.
LinphoneChatRoomHistoryFilter is used to determine which filter to apply to history functions.
TODO move to encryption engine object when available LinphoneChatRoomSecurityLevel is used to indicate the encryption security level of a chat room.
LinphoneChatRoomState is used to indicate the current state of a chat room.
Ephemeral chat message policies.
This enum represents different policies for managing ephemeral chat message lifetimes.
| LinphoneChatMessageCbsContentEditedCb linphone_chat_message_cbs_get_content_edited | ( | const LinphoneChatMessageCbs * | cbs | ) |
Gets the content edited callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsEphemeralMessageDeletedCb linphone_chat_message_cbs_get_ephemeral_message_deleted | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the ephemeral message deleted callback.
This callback is used when a message deletion timer runs out (message is deleted).
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsEphemeralMessageTimerStartedCb linphone_chat_message_cbs_get_ephemeral_message_timer_started | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the current "ephemeral message timer started" callback.
This callback is called when the message deletion timer starts (the message has been viewed).
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsFileTransferProgressIndicationCb linphone_chat_message_cbs_get_file_transfer_progress_indication | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the file transfer progress indication callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsFileTransferRecvCb linphone_chat_message_cbs_get_file_transfer_recv | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the file transfer receive callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsFileTransferSendCb linphone_chat_message_cbs_get_file_transfer_send | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the file transfer send callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsFileTransferSendChunkCb linphone_chat_message_cbs_get_file_transfer_send_chunk | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the file transfer send callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsFileTransferTerminatedCb linphone_chat_message_cbs_get_file_transfer_terminated | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the download file transfer terminated callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsMsgStateChangedCb linphone_chat_message_cbs_get_msg_state_changed | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the message state changed callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsNewMessageReactionCb linphone_chat_message_cbs_get_new_message_reaction | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the new reaction callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsParticipantImdnStateChangedCb linphone_chat_message_cbs_get_participant_imdn_state_changed | ( | const LinphoneChatMessageCbs * | cbs | ) |
Get the participant IMDN state changed callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsReactionRemovedCb linphone_chat_message_cbs_get_reaction_removed | ( | const LinphoneChatMessageCbs * | cbs | ) |
Gets the removed reaction callback.
| cbs | LinphoneChatMessageCbs object. |
| LinphoneChatMessageCbsRetractedCb linphone_chat_message_cbs_get_retracted | ( | const LinphoneChatMessageCbs * | cbs | ) |
Gets the retracted callback.
| cbs | LinphoneChatMessageCbs object. |
| void * linphone_chat_message_cbs_get_user_data | ( | const LinphoneChatMessageCbs * | cbs | ) |
Retrieve the user pointer associated with the chat message callbacks object.
| cbs | The LinphoneChatMessageCbs object |
| LinphoneChatMessageCbs * linphone_chat_message_cbs_ref | ( | LinphoneChatMessageCbs * | cbs | ) |
Acquire a reference to the chat message callbacks object.
| cbs | The LinphoneChatMessageCbs object |
| void linphone_chat_message_cbs_set_content_edited | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsContentEditedCb | cb | ||
| ) |
Sets the content edited callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The new content edited callback to be used. |
| void linphone_chat_message_cbs_set_ephemeral_message_deleted | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsEphemeralMessageDeletedCb | cb | ||
| ) |
Set the ephemeral message deleted callback.
This callback is used when new message deletion timer runs out (message is deleted).
| cbs | LinphoneChatMessageCbs object. |
| cb | The ephemeral message deleted callback to be used. |
| void linphone_chat_message_cbs_set_ephemeral_message_timer_started | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsEphemeralMessageTimerStartedCb | cb | ||
| ) |
Set the ephemeral message timer started callback.
This callback will be used when new message deletion timer starts (the message has been viewed).
| cbs | LinphoneChatMessageCbs object. |
| cb | The ephemeral message timer started callback to be used. |
| void linphone_chat_message_cbs_set_file_transfer_progress_indication | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsFileTransferProgressIndicationCb | cb | ||
| ) |
Set the file transfer progress indication callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The file transfer progress indication callback to be used. |
| void linphone_chat_message_cbs_set_file_transfer_recv | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsFileTransferRecvCb | cb | ||
| ) |
Set the file transfer receive callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The file transfer receive callback to be used. |
| void linphone_chat_message_cbs_set_file_transfer_send | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsFileTransferSendCb | cb | ||
| ) |
Set the file transfer send callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The file transfer send callback to be used. |
| void linphone_chat_message_cbs_set_file_transfer_send_chunk | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsFileTransferSendChunkCb | cb | ||
| ) |
Set the file transfer send callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The file transfer send callback to be used. |
| void linphone_chat_message_cbs_set_file_transfer_terminated | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsFileTransferTerminatedCb | cb | ||
| ) |
Set the file transfer terminated callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The file transfer terminated callback to be used. |
| void linphone_chat_message_cbs_set_msg_state_changed | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsMsgStateChangedCb | cb | ||
| ) |
Set the message state changed callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The message state changed callback to be used. |
| void linphone_chat_message_cbs_set_new_message_reaction | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsNewMessageReactionCb | cb | ||
| ) |
Set the new reaction callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The new reaction callback to be used. |
| void linphone_chat_message_cbs_set_participant_imdn_state_changed | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsParticipantImdnStateChangedCb | cb | ||
| ) |
Set the participant IMDN state changed callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The participant IMDN state changed callback to be used. |
| void linphone_chat_message_cbs_set_reaction_removed | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsReactionRemovedCb | cb | ||
| ) |
Sets the removed reaction callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The new reaction callback to be used. |
| void linphone_chat_message_cbs_set_retracted | ( | LinphoneChatMessageCbs * | cbs, |
| LinphoneChatMessageCbsRetractedCb | cb | ||
| ) |
Sets the retracted callback.
| cbs | LinphoneChatMessageCbs object. |
| cb | The new retracted callback to be used. |
| void linphone_chat_message_cbs_set_user_data | ( | LinphoneChatMessageCbs * | cbs, |
| void * | user_data | ||
| ) |
Assign a user pointer to the chat message callbacks object.
| cbs | The LinphoneChatMessageCbs object |
| user_data | The user pointer to associate with the chat message callbacks object. |
| void linphone_chat_message_cbs_unref | ( | LinphoneChatMessageCbs * | cbs | ) |
Release reference to the chat message callbacks object.
| cbs | The LinphoneChatMessageCbs object |
| const char * linphone_chat_message_reaction_get_body | ( | const LinphoneChatMessageReaction * | reaction | ) |
Returns the emoji(s) used for the reaction.
| reaction | the LinphoneChatMessageReaction. |
| const char * linphone_chat_message_reaction_get_call_id | ( | const LinphoneChatMessageReaction * | reaction | ) |
Allows to get the Call ID associated with a LinphoneChatMessageReaction.
| reaction | the LinphoneChatMessageReaction. |
| const LinphoneAddress * linphone_chat_message_reaction_get_from_address | ( | const LinphoneChatMessageReaction * | reaction | ) |
Returns the LinphoneAddress of the participant that sent this reaction.
| reaction | the LinphoneChatMessageReaction. |
| LinphoneChatMessageReaction * linphone_chat_message_reaction_ref | ( | LinphoneChatMessageReaction * | reaction | ) |
Takes a reference on a LinphoneChatMessageReaction.
| reaction | the LinphoneChatMessageReaction. |
| void linphone_chat_message_reaction_send | ( | LinphoneChatMessageReaction * | reaction | ) |
Sends a LinphoneChatMessageReaction.
| reaction | the LinphoneChatMessageReaction to send. |
| void linphone_chat_message_reaction_unref | ( | LinphoneChatMessageReaction * | reaction | ) |
Releases a LinphoneChatMessageReaction reference.
| reaction | the LinphoneChatMessageReaction |
| void linphone_chat_room_add_callbacks | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatRoomCbs * | cbs | ||
| ) |
Adds a listener in order to be notified of LinphoneChatRoom events.
Once an event is received, registred LinphoneChatRoomCbs are invoked sequencially.
| chat_room | LinphoneChatRoom object to monitor. |
| cbs | A LinphoneChatRoomCbs object holding the callbacks you need. A reference is taken by the LinphoneChatRoom until you invoke linphone_call_remove_callbacks(). |
| void linphone_chat_room_add_participant | ( | LinphoneChatRoom * | chat_room, |
| LinphoneAddress * | addr | ||
| ) |
Adds a participant to a chat room.
This may fail if this type of chat room does not handle participants. Use linphone_chat_room_can_handle_participants() to know if this chat room handles participants.
| chat_room | A LinphoneChatRoom object |
| addr | The address of the participant to add to the chat room |
| bool_t linphone_chat_room_add_participants | ( | LinphoneChatRoom * | chat_room, |
| const bctbx_list_t * | addresses | ||
| ) |
Adds several participants to a chat room at once.
This may fail if this type of chat room does not handle participants. Use linphone_chat_room_can_handle_participants() to know if this chat room handles participants.
| chat_room | A LinphoneChatRoom object |
| addresses | The participants to add. |
| bool_t linphone_chat_room_can_handle_participants | ( | const LinphoneChatRoom * | chat_room | ) |
Tells whether a chat room is able to handle participants.
| chat_room | A LinphoneChatRoom object |
| LinphoneChatRoomCbsChatMessageParticipantImdnStateChangedCb linphone_chat_room_cbs_get_chat_message_participant_imdn_state_changed | ( | LinphoneChatRoomCbs * | cbs | ) |
Get the message's participant state changed callback.
| cbs | LinphoneChatRoomCbs object |
| LinphoneChatRoomCbsChatMessageReceivedCb linphone_chat_room_cbs_get_chat_message_received | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the chat message received callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsChatMessageSendingCb linphone_chat_room_cbs_get_chat_message_sending | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the chat message sending callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsChatMessageSentCb linphone_chat_room_cbs_get_chat_message_sent | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the chat message sent callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsShouldChatMessageBeStoredCb linphone_chat_room_cbs_get_chat_message_should_be_stored | ( | LinphoneChatRoomCbs * | cbs | ) |
Get the message should be stored callback.
| cbs | LinphoneChatRoomCbs object |
| LinphoneChatRoomCbsChatMessagesReceivedCb linphone_chat_room_cbs_get_chat_messages_received | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the chat messages received callback.
Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled()), it replaces the single chat message received callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsChatRoomReadCb linphone_chat_room_cbs_get_chat_room_read | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the "marked as read" callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsConferenceAddressGenerationCb linphone_chat_room_cbs_get_conference_address_generation | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the conference address generation callback.
| cbs | LinphoneChatRoomCbs object |
| LinphoneChatRoomCbsConferenceJoinedCb linphone_chat_room_cbs_get_conference_joined | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the conference joined callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsConferenceLeftCb linphone_chat_room_cbs_get_conference_left | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the conference left callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsEphemeralEventCb linphone_chat_room_cbs_get_ephemeral_event | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the ephemeral event callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsEphemeralMessageDeletedCb linphone_chat_room_cbs_get_ephemeral_message_deleted | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the ephemeral message deleted callback.
This callback is used when a message deletion timer runs out (message is deleted).
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsEphemeralMessageTimerStartedCb linphone_chat_room_cbs_get_ephemeral_message_timer_started | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the current "ephemeral message timer started" callback.
This callback is called when a message deletion timer starts (the message has been viewed).
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsIsComposingReceivedCb linphone_chat_room_cbs_get_is_composing_received | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the is-composing received callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsMessageContentEditedCb linphone_chat_room_cbs_get_message_content_edited | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the message content edited callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsMessageEarlyFailureCb linphone_chat_room_cbs_get_message_early_failure | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the message early failure callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsMessageReceivedCb linphone_chat_room_cbs_get_message_received | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the message received callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsMessageRetractedCb linphone_chat_room_cbs_get_message_retracted | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the message retracted callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsMessagesReceivedCb linphone_chat_room_cbs_get_messages_received | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the chat messages received callback.
Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled()), it replaces the single message received callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsNewEventCb linphone_chat_room_cbs_get_new_event | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the new event log callback.
This callback will be called before every other LinphoneEventLog related callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsNewEventsCb linphone_chat_room_cbs_get_new_events | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the new event logs callback.
This callback will be called before every other LinphoneEventLog related callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsNewMessageReactionCb linphone_chat_room_cbs_get_new_message_reaction | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the new reaction callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsOperationFailedCb linphone_chat_room_cbs_get_operation_failed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the leave failed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantAddedCb linphone_chat_room_cbs_get_participant_added | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant added callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantAdminStatusChangedCb linphone_chat_room_cbs_get_participant_admin_status_changed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant admin status changed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantDeviceAddedCb linphone_chat_room_cbs_get_participant_device_added | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant device added callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantDeviceMediaAvailabilityChangedCb linphone_chat_room_cbs_get_participant_device_media_availability_changed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant device media availability changed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantDeviceRemovedCb linphone_chat_room_cbs_get_participant_device_removed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant device removed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantDeviceStateChangedCb linphone_chat_room_cbs_get_participant_device_state_changed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant device state callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsParticipantRegistrationSubscriptionRequestedCb linphone_chat_room_cbs_get_participant_registration_subscription_requested | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant registration subscription callback.
| cbs | LinphoneChatRoomCbs object |
| LinphoneChatRoomCbsParticipantRegistrationUnsubscriptionRequestedCb linphone_chat_room_cbs_get_participant_registration_unsubscription_requested | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant registration unsubscription callback.
| cbs | LinphoneChatRoomCbs object |
| LinphoneChatRoomCbsParticipantRemovedCb linphone_chat_room_cbs_get_participant_removed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the participant removed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsSecurityEventCb linphone_chat_room_cbs_get_security_event | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the security event callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsStateChangedCb linphone_chat_room_cbs_get_state_changed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the state changed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsSubjectChangedCb linphone_chat_room_cbs_get_subject_changed | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the subject changed callback.
| cbs | LinphoneChatRoomCbs object. |
| LinphoneChatRoomCbsUndecryptableMessageReceivedCb linphone_chat_room_cbs_get_undecryptable_message_received | ( | const LinphoneChatRoomCbs * | cbs | ) |
Get the undecryptable message received callback.
| cbs | LinphoneChatRoomCbs object. |
| void * linphone_chat_room_cbs_get_user_data | ( | const LinphoneChatRoomCbs * | cbs | ) |
Retrieve the user pointer associated with the chat room callbacks object.
| cbs | The chat room callbacks object |
| LinphoneChatRoomCbs * linphone_chat_room_cbs_ref | ( | LinphoneChatRoomCbs * | cbs | ) |
Acquire a reference to the chat room callbacks object.
| cbs | The LinphoneChatRoomCbs object |
| void linphone_chat_room_cbs_set_chat_message_participant_imdn_state_changed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsChatMessageParticipantImdnStateChangedCb | cb | ||
| ) |
Set the message's participant state changed callback callback.
| cbs | LinphoneChatRoomCbs object |
| cb | The message's participant state changed callback to be used |
| void linphone_chat_room_cbs_set_chat_message_received | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsChatMessageReceivedCb | cb | ||
| ) |
Set the chat message received callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The chat message received callback to be used. |
| void linphone_chat_room_cbs_set_chat_message_sending | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsChatMessageSendingCb | cb | ||
| ) |
Set the chat message sending callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The chat message being sent callback to be used. |
| void linphone_chat_room_cbs_set_chat_message_sent | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsChatMessageSentCb | cb | ||
| ) |
Set the chat message sent callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The chat message sent callback to be used. |
| void linphone_chat_room_cbs_set_chat_message_should_be_stored | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsShouldChatMessageBeStoredCb | cb | ||
| ) |
Set the message should be stored callback.
| cbs | LinphoneChatRoomCbs object |
| cb | The message should be stored callback to be used |
| void linphone_chat_room_cbs_set_chat_messages_received | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsChatMessagesReceivedCb | cb | ||
| ) |
Set the chat messages received callback.
Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled()), it replaces the single chat message received callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The chat message received callback to be used. |
| void linphone_chat_room_cbs_set_chat_room_read | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsChatRoomReadCb | cb | ||
| ) |
Set the "marked as read" callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The marked as read callback to be used. |
| void linphone_chat_room_cbs_set_conference_address_generation | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsConferenceAddressGenerationCb | cb | ||
| ) |
Set the conference address generation callback.
| cbs | LinphoneChatRoomCbs object |
| cb | The conference address generation callback to be used |
| void linphone_chat_room_cbs_set_conference_joined | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsConferenceJoinedCb | cb | ||
| ) |
Set the conference joined callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The conference joined callback to be used. |
| void linphone_chat_room_cbs_set_conference_left | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsConferenceLeftCb | cb | ||
| ) |
Set the conference left callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The conference left callback to be used. |
| void linphone_chat_room_cbs_set_ephemeral_event | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsEphemeralEventCb | cb | ||
| ) |
Set the ephemeral event callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The ephemeral event callback to be used. |
| void linphone_chat_room_cbs_set_ephemeral_message_deleted | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsEphemeralMessageDeletedCb | cb | ||
| ) |
Set the ephemeral message deleted callback.
This callback is used when new message deletion timer runs out (message is deleted).
| cbs | LinphoneChatRoomCbs object. |
| cb | The ephemeral message deleted callback to be used. |
| void linphone_chat_room_cbs_set_ephemeral_message_timer_started | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsEphemeralMessageTimerStartedCb | cb | ||
| ) |
Set the ephemeral message timer started callback.
This callback will be used when new message deletion timer starts (the message has been viewed).
| cbs | LinphoneChatRoomCbs object. |
| cb | The ephemeral message timer started callback to be used. |
| void linphone_chat_room_cbs_set_is_composing_received | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsIsComposingReceivedCb | cb | ||
| ) |
Set the is-composing received callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The is-composing received callback to be used. |
| void linphone_chat_room_cbs_set_message_content_edited | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsMessageContentEditedCb | cb | ||
| ) |
Set the message content edited callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The new message content edited to be used. |
| void linphone_chat_room_cbs_set_message_early_failure | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsMessageEarlyFailureCb | cb | ||
| ) |
Set the message early failure callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The message early failure callback to be used. |
| void linphone_chat_room_cbs_set_message_received | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsMessageReceivedCb | cb | ||
| ) |
Set the message received callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The message received callback to be used. |
| void linphone_chat_room_cbs_set_message_retracted | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsMessageRetractedCb | cb | ||
| ) |
Set the message retracted callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The new message retracted to be used. |
| void linphone_chat_room_cbs_set_messages_received | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsMessagesReceivedCb | cb | ||
| ) |
Set the chat message received callback.
Only called when aggregation is enabled (aka [sip] chat_messages_aggregation == 1 or using linphone_core_set_chat_messages_aggregation_enabled()), it replaces the single message received callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The chat messages received callback to be used. |
| void linphone_chat_room_cbs_set_new_event | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsNewEventCb | cb | ||
| ) |
Set the new event log callback.
This callback will be called before every other LinphoneEventLog related callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The event log created callback to be used. |
| void linphone_chat_room_cbs_set_new_events | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsNewEventsCb | cb | ||
| ) |
Set the new event logs callback.
This callback will be called before every other LinphoneEventLog related callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The event logs created callback to be used. |
| void linphone_chat_room_cbs_set_new_message_reaction | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsNewMessageReactionCb | cb | ||
| ) |
Set the new reaction callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The new reaction callback to be used. |
| void linphone_chat_room_cbs_set_operation_failed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsOperationFailedCb | cb | ||
| ) |
Set the leave failed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The leave failed callback to be used. |
| void linphone_chat_room_cbs_set_participant_added | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantAddedCb | cb | ||
| ) |
Set the participant added callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant added callback to be used. |
| void linphone_chat_room_cbs_set_participant_admin_status_changed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantAdminStatusChangedCb | cb | ||
| ) |
Set the participant admin status changed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant admin status changed callback to be used. |
| void linphone_chat_room_cbs_set_participant_device_added | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantDeviceAddedCb | cb | ||
| ) |
Set the participant device added callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant device added callback to be used. |
| void linphone_chat_room_cbs_set_participant_device_media_availability_changed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantDeviceMediaAvailabilityChangedCb | cb | ||
| ) |
Set the participant device media availability changed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant device media availability changed callback to be used. |
| void linphone_chat_room_cbs_set_participant_device_removed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantDeviceRemovedCb | cb | ||
| ) |
Set the participant device removed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant device removed callback to be used. |
| void linphone_chat_room_cbs_set_participant_device_state_changed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantDeviceStateChangedCb | cb | ||
| ) |
Set the participant device state callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant device state callback to be used. |
| void linphone_chat_room_cbs_set_participant_registration_subscription_requested | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantRegistrationSubscriptionRequestedCb | cb | ||
| ) |
Set the participant registration subscription callback.
| cbs | LinphoneChatRoomCbs object |
| cb | The participant registration subscription callback to be used |
| void linphone_chat_room_cbs_set_participant_registration_unsubscription_requested | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantRegistrationUnsubscriptionRequestedCb | cb | ||
| ) |
Set the participant registration unsubscription callback.
| cbs | LinphoneChatRoomCbs object |
| cb | The participant registration unsubscription callback to be used |
| void linphone_chat_room_cbs_set_participant_removed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsParticipantRemovedCb | cb | ||
| ) |
Set the participant removed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The participant removed callback to be used. |
| void linphone_chat_room_cbs_set_security_event | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsSecurityEventCb | cb | ||
| ) |
Set the security event callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The security event callback to be used. |
| void linphone_chat_room_cbs_set_state_changed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsStateChangedCb | cb | ||
| ) |
Set the state changed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The state changed callback to be used. |
| void linphone_chat_room_cbs_set_subject_changed | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsSubjectChangedCb | cb | ||
| ) |
Set the subject changed callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The subject changed callback to be used. |
| void linphone_chat_room_cbs_set_undecryptable_message_received | ( | LinphoneChatRoomCbs * | cbs, |
| LinphoneChatRoomCbsUndecryptableMessageReceivedCb | cb | ||
| ) |
Set the undecryptable message received callback.
| cbs | LinphoneChatRoomCbs object. |
| cb | The undecryptable message received callback to be used. |
| void linphone_chat_room_cbs_set_user_data | ( | LinphoneChatRoomCbs * | cbs, |
| void * | user_data | ||
| ) |
Assign a user pointer to the chat room callbacks object.
| cbs | The chat room callbacks object |
| user_data | The user pointer to associate with the chat room callbacks object. |
| void linphone_chat_room_cbs_unref | ( | LinphoneChatRoomCbs * | cbs | ) |
Release reference to the chat room callbacks object.
| cbs | The chat room callbacks object |
| int linphone_chat_room_close | ( | LinphoneChatRoom * | chat_room | ) |
Terminates a chat room and instruct the server to remove all participants.
| chat_room | A LinphoneChatRoom object |
| MS2_DEPRECATED void linphone_chat_room_compose | ( | LinphoneChatRoom * | chat_room | ) |
Notifies the destination of the chat message being composed that the user is typing a new message.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which a new message is being typed. |
| void linphone_chat_room_compose_text_message | ( | LinphoneChatRoom * | chat_room | ) |
Notifies the destination of the chat message being composed that the user is typing a message.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which a message is being typed. |
| void linphone_chat_room_compose_voice_message | ( | LinphoneChatRoom * | chat_room | ) |
Notifies the destination of the chat message being composed that the user is recording a new voice message.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which a voice message is being recorded. |
| LinphoneChatMessage * linphone_chat_room_create_empty_message | ( | LinphoneChatRoom * | chat_room | ) |
Creates an empty message attached to the given chat room.
| chat_room | the LinphoneChatRoom object. |
| LinphoneChatMessage * linphone_chat_room_create_file_transfer_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneContent * | initial_content | ||
| ) |
Creates a message attached to the given chat room with a particular content.
Use linphone_chat_message_send() to initiate the transfer
| chat_room | the LinphoneChatRoom object. |
| initial_content | LinphoneContent initial content. |
| LinphoneChatMessage * linphone_chat_room_create_forward_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Creates a forward message attached to the given chat room with a particular message.
| chat_room | the LinphoneChatRoom object. |
| message | LinphoneChatMessage message to be forwarded. |
| MS2_DEPRECATED LinphoneChatMessage * linphone_chat_room_create_message | ( | LinphoneChatRoom * | chat_room, |
| const char * | message | ||
| ) |
Creates a message attached to the given chat room with a plain text content filled with the given message.
| chat_room | the LinphoneChatRoom object. |
| message | text message, NULL if absent. |
| MS2_DEPRECATED LinphoneChatMessage * linphone_chat_room_create_message_2 | ( | LinphoneChatRoom * | chat_room, |
| const char * | message, | ||
| const char * | external_body_url, | ||
| LinphoneChatMessageState | state, | ||
| time_t | time, | ||
| bool_t | is_read, | ||
| bool_t | is_incoming | ||
| ) |
Creates a message attached to the given chat room.
| chat_room | the LinphoneChatRoom object. |
| message | text message, NULL if absent. |
| external_body_url | the URL given in external body or NULL. |
| state | the LinphoneChatMessage. State of the message. |
| time | the time_t at which the message has been received/sent. |
| is_read | TRUE if the message should be flagged as read, FALSE otherwise. |
| is_incoming | TRUE if the message has been received, FALSE otherwise. |
| LinphoneChatMessage * linphone_chat_room_create_message_from_utf8 | ( | LinphoneChatRoom * | chat_room, |
| const char * | message | ||
| ) |
Creates a message attached to the given chat room with a plain text content filled with the given message.
Introduced in 01/07/2020
| chat_room | the LinphoneChatRoom object. |
| message | text message in UTF8, NULL if absent. |
| LinphoneChatMessage * linphone_chat_room_create_replaces_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Creates a replaces message that will edit the original message.
| chat_room | the LinphoneChatRoom object. |
| message | LinphoneChatMessage message to edit. |
| LinphoneChatMessage * linphone_chat_room_create_reply_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Creates a reply message attached to the given chat room with a particular message.
| chat_room | the LinphoneChatRoom object. |
| message | LinphoneChatMessage message to reply to. |
| LinphoneChatMessage * linphone_chat_room_create_voice_recording_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneRecorder * | recorder | ||
| ) |
Creates a chat message with a voice recording attached to the given chat room.
| chat_room | the LinphoneChatRoom object. |
| recorder | the LinphoneRecorder object used to record the voice message. |
| void linphone_chat_room_delete_history | ( | LinphoneChatRoom * | chat_room | ) |
Delete all messages from the history.
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| void linphone_chat_room_delete_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Delete a message from the chat room history.
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| message | The LinphoneChatMessage object to remove. |
| void linphone_chat_room_enable_ephemeral | ( | LinphoneChatRoom * | chat_room, |
| bool_t | enable | ||
| ) |
Enable or disable the ephemeral message feature in the chat room.
Works only for flexisip-based chat room. An ephemeral message will automatically disappear from the sender and recipient's chatrooms after a specified timeout configurable with linphone_chat_room_set_ephemeral_lifetime(). The timer starts when the message has been displayed at the recipent, which means:
| chat_room | LinphoneChatRoom object |
| enable | TRUE if the ephemeral message feature is enabled, FALSE otherwise. |
| bool_t linphone_chat_room_ephemeral_enabled | ( | const LinphoneChatRoom * | chat_room | ) |
Returns whether or not the ephemeral message feature is enabled in the chat room.
| chat_room | The LinphoneChatRoom object corresponding to the conversation |
| bool_t linphone_chat_room_ephemeral_supported_by_all_participants | ( | const LinphoneChatRoom * | chat_room | ) |
Check if all participants support ephemeral messages.
It doesn't prevent to send ephemeral messages in the room but those who don't support it won't delete messages after lifetime has expired. The check is done by verifying the participant's advertised capabilities (+org.linphone.specs parameter).
| chat_room | LinphoneChatRoom object |
| LinphoneEventLog * linphone_chat_room_find_event_log | ( | LinphoneChatRoom * | chat_room, |
| const char * | message_id | ||
| ) |
Gets the event log sent or received in this chat room that matches a chat message with the given message_id.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which the message should be retrieved |
| message_id | The id of the message to find |
| LinphoneChatMessage * linphone_chat_room_find_message | ( | LinphoneChatRoom * | chat_room, |
| const char * | message_id | ||
| ) |
Gets the chat message sent or received in this chat room that matches the message_id.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which the message should be retrieved |
| message_id | The id of the message to find |
| LinphoneParticipant * linphone_chat_room_find_participant | ( | const LinphoneChatRoom * | chat_room, |
| LinphoneAddress * | address | ||
| ) |
Finds a participant of a chat room from its address.
| chat_room | A LinphoneChatRoom object |
| address | The LinphoneAddress to search in the list of participants of the chat room |
| LinphoneAccount * linphone_chat_room_get_account | ( | LinphoneChatRoom * | chat_room | ) |
Returns the local account to which this chat room is related.
| chat_room | The LinphoneChatRoom object. |
| LinphoneCall * linphone_chat_room_get_call | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the current call associated to this chatroom if any To commit a message, use linphone_chat_message_send()
| chat_room | the LinphoneChatRoom object |
| LinphoneChatRoomCapabilitiesMask linphone_chat_room_get_capabilities | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the capabilities of a chat room.
| chat_room | A LinphoneChatRoom object |
| uint32_t linphone_chat_room_get_char | ( | LinphoneChatRoom * | chat_room | ) |
When realtime text is enabled in a LinphoneCall (see linphone_call_params_realtime_text_enabled()), LinphoneCoreIsComposingReceivedCb is called everytime a Real-Time Text character is received from peer.
linphone_chat_room_get_char() pops a character previously received from the receive queue, and returns it. When a new line character is received, a LinphoneChatMessage is automatically created with received characters and notified to the application through the LinphoneCoreCbs or LinphoneChatRoomCbs interfaces.
| chat_room | LinphoneChatRoom object |
| const bctbx_list_t * linphone_chat_room_get_composing_addresses | ( | LinphoneChatRoom * | chat_room | ) |
Gets the list of participants that are currently composing.
| chat_room | A LinphoneChatRoom object |
| const bctbx_list_t * linphone_chat_room_get_composing_participants | ( | LinphoneChatRoom * | chat_room | ) |
Gets the list of participants that are currently composing.
| chat_room | A LinphoneChatRoom object |
| const LinphoneAddress * linphone_chat_room_get_conference_address | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the conference address of the chat room.
| chat_room | A LinphoneChatRoom object |
| const LinphoneConferenceInfo * linphone_chat_room_get_conference_info | ( | LinphoneChatRoom * | chat_room | ) |
Gets the conference information associated to the chatroom.
| chat_room | The LinphoneChatRoom object. |
| LinphoneCore * linphone_chat_room_get_core | ( | const LinphoneChatRoom * | chat_room | ) |
Returns back pointer to LinphoneCore object.
| chat_room | the LinphoneChatRoom object. |
| time_t linphone_chat_room_get_creation_time | ( | const LinphoneChatRoom * | chat_room | ) |
Returns the creation time for the chat room.
| chat_room | LinphoneChatRoom object |
| LinphoneChatRoomCbs * linphone_chat_room_get_current_callbacks | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the current LinphoneChatRoomCbs.
This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneChatRoomCbs that is calling the callback.
| chat_room | LinphoneChatRoom object |
| const LinphoneChatRoomParams * linphone_chat_room_get_current_params | ( | const LinphoneChatRoom * | chat_room | ) |
Returns current parameters associated with the chat room.
This is typically the parameters passed during the LinphoneChatRoom creation process to linphone_core_create_chat_room_7() or some default parameters if no LinphoneChatRoomParams was explicitely passed during LinphoneChatRoom creation.
| chat_room | the LinphoneChatRoom object |
| bctbx_list_t * linphone_chat_room_get_document_contents | ( | LinphoneChatRoom * | chat_room | ) |
Gets all contents for which content-type starts with either text/ or application/.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which matching contents should be retrieved. |
| bctbx_list_t * linphone_chat_room_get_document_contents_range | ( | LinphoneChatRoom * | chat_room, |
| int | begin, | ||
| int | end | ||
| ) |
Gets the partial list of contents for which content-type starts with either text/ or application/.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which matching contents should be retrieved. |
| begin | The first content of the range to be retrieved. Most recent content has index 0. |
| end | The last content of the range to be retrieved. Oldest content has index of size (use linphone_chat_room_get_document_contents_size() to retrieve size) |
| int linphone_chat_room_get_document_contents_size | ( | LinphoneChatRoom * | chat_room | ) |
Gets the number of document contents (see linphone_chat_room_get_document_contents()).
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which document contents size should be retrieved. |
| long linphone_chat_room_get_ephemeral_lifetime | ( | const LinphoneChatRoom * | chat_room | ) |
Gets lifetime (in seconds) for all new ephemeral messages in the chat room.
After the message is read, it will be deleted after "time" seconds.
| chat_room | LinphoneChatRoom object |
| LinphoneChatRoomEphemeralMode linphone_chat_room_get_ephemeral_mode | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the ephemeral mode of the chat room.
| chat_room | LinphoneChatRoom object |
| long linphone_chat_room_get_ephemeral_not_read_lifetime | ( | const LinphoneChatRoom * | chat_room | ) |
Gets not-read lifetime (in seconds) for all new ephemeral messages in the chat room.
If the message is not read, it will be deleted after "time" seconds.
| chat_room | LinphoneChatRoom object |
| bctbx_list_t * linphone_chat_room_get_history | ( | LinphoneChatRoom * | chat_room, |
| int | nb_message | ||
| ) |
Gets nb_message most recent messages from chat_room chat room, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved |
| nb_message | Number of message to retrieve. 0 means everything. |
| bctbx_list_t * linphone_chat_room_get_history_2 | ( | LinphoneChatRoom * | chat_room, |
| int | nb_message, | ||
| LinphoneChatRoomHistoryFilterMask | filters | ||
| ) |
Gets nb_message most recent events from chat_room chat room, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which events should be retrieved |
| nb_message | Number of events to retrieve. 0 means everything. |
| filters | The LinphoneChatRoomHistoryFilterMask mask to filter the results with LinphoneChatRoomHistoryFilter |
| bctbx_list_t * linphone_chat_room_get_history_events | ( | LinphoneChatRoom * | chat_room, |
| int | nb_events | ||
| ) |
Gets nb_events most recent events from chat_room chat room, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which events should be retrieved |
| nb_events | Number of events to retrieve. 0 means everything. |
| int linphone_chat_room_get_history_events_size | ( | LinphoneChatRoom * | chat_room | ) |
Gets the number of events in a chat room.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which size has to be computed |
| bctbx_list_t * linphone_chat_room_get_history_message_events | ( | LinphoneChatRoom * | chat_room, |
| int | nb_events | ||
| ) |
Gets nb_events most recent chat message events from chat_room chat room, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which events should be retrieved |
| nb_events | Number of events to retrieve. 0 means everything. |
| bctbx_list_t * linphone_chat_room_get_history_range | ( | LinphoneChatRoom * | chat_room, |
| int | begin, | ||
| int | end | ||
| ) |
Gets the partial list of messages in the given range, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved |
| begin | The first message of the range to be retrieved. History most recent message has index 0. |
| end | The last message of the range to be retrieved. History oldest message has index of history size (use linphone_chat_room_get_history_size() to retrieve history size) |
| bctbx_list_t * linphone_chat_room_get_history_range_2 | ( | LinphoneChatRoom * | chat_room, |
| int | begin, | ||
| int | end, | ||
| LinphoneChatRoomHistoryFilterMask | filters | ||
| ) |
Gets the partial list of events in the given range, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved |
| begin | The first event of the range to be retrieved. History most recent message has index 0. |
| end | The last event of the range to be retrieved. History oldest message has index of history size (use linphone_chat_room_get_history_size_2() to retrieve history size) |
| filters | The LinphoneChatRoomHistoryFilterMask mask to filter the results with LinphoneChatRoomHistoryFilter |
| bctbx_list_t * linphone_chat_room_get_history_range_between | ( | LinphoneChatRoom * | chat_room, |
| LinphoneEventLog * | first_event, | ||
| LinphoneEventLog * | last_event, | ||
| LinphoneChatRoomHistoryFilterMask | filters | ||
| ) |
Gets the partial list of messages between two given LinphoneEventLog, sorted from oldest to most recent.
If either first_event or last_event is null, then nothing is returned.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved |
| first_event | The LinphoneEventLog object corresponding to the event. |
| last_event | The LinphoneEventLog object corresponding to the event. |
| filters | The LinphoneChatRoomHistoryFilterMask mask to filter the results with LinphoneChatRoomHistoryFilter |
| bctbx_list_t * linphone_chat_room_get_history_range_events | ( | LinphoneChatRoom * | chat_room, |
| int | begin, | ||
| int | end | ||
| ) |
Gets the partial list of events in the given range, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which events should be retrieved |
| begin | The first event of the range to be retrieved. History most recent event has index 0. |
| end | The last event of the range to be retrieved. History oldest event has index of history size |
| bctbx_list_t * linphone_chat_room_get_history_range_message_events | ( | LinphoneChatRoom * | chat_room, |
| int | begin, | ||
| int | end | ||
| ) |
Gets the partial list of chat message events in the given range, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which events should be retrieved |
| begin | The first event of the range to be retrieved. History most recent event has index 0. |
| end | The last event of the range to be retrieved. History oldest event has index of history size |
| bctbx_list_t * linphone_chat_room_get_history_range_near | ( | LinphoneChatRoom * | chat_room, |
| unsigned int | before, | ||
| unsigned int | after, | ||
| LinphoneEventLog * | event, | ||
| LinphoneChatRoomHistoryFilterMask | filters | ||
| ) |
Gets the partial list of messages in the given range near the LinphoneEventLog provided, sorted from oldest to most recent.
If before and after are both set to 0, the returned list is empty.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved |
| before | The number of messages to retrieve before the event provided. |
| after | The number of messages to retrieve after the event provided. |
| event | The LinphoneEventLog object corresponding to the event. |
| filters | The LinphoneChatRoomHistoryFilterMask mask to filter the results with LinphoneChatRoomHistoryFilter |
| int linphone_chat_room_get_history_size | ( | LinphoneChatRoom * | chat_room | ) |
Gets the number of messages in a chat room.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which size has to be computed |
| int linphone_chat_room_get_history_size_2 | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatRoomHistoryFilterMask | filters | ||
| ) |
Gets the number of messages in a chat room.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which size has to be computed |
| filters | The LinphoneChatRoomHistoryFilterMask mask to filter the result with LinphoneChatRoomHistoryFilter |
| const char * linphone_chat_room_get_identifier | ( | const LinphoneChatRoom * | chat_room | ) |
Returns the chat room identifier.
| chat_room | The LinphoneChatRoom object. |
| LinphoneChatMessage * linphone_chat_room_get_last_message_in_history | ( | LinphoneChatRoom * | chat_room | ) |
Gets the last chat message sent or received in this chat room.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which last message should be retrieved |
| time_t linphone_chat_room_get_last_update_time | ( | const LinphoneChatRoom * | chat_room | ) |
Returns the last updated time for the chat room.
| chat_room | LinphoneChatRoom object |
| MS2_DEPRECATED LinphoneCore * linphone_chat_room_get_lc | ( | const LinphoneChatRoom * | chat_room | ) |
Returns back pointer to LinphoneCore object.
| const LinphoneAddress * linphone_chat_room_get_local_address | ( | LinphoneChatRoom * | chat_room | ) |
Get the local address associated to this chat room.
| chat_room | LinphoneChatRoom object. |
| LinphoneParticipant * linphone_chat_room_get_me | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the participant representing myself in the chat room.
| chat_room | A LinphoneChatRoom object |
| bctbx_list_t * linphone_chat_room_get_media_contents | ( | LinphoneChatRoom * | chat_room | ) |
Gets all contents for which content-type starts with either video/, audio/ or image/.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which matching contents should be retrieved. |
| bctbx_list_t * linphone_chat_room_get_media_contents_range | ( | LinphoneChatRoom * | chat_room, |
| int | begin, | ||
| int | end | ||
| ) |
Gets the partial list of contents for which content-type starts with either video/, audio/ or image/.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which matching contents should be retrieved. |
| begin | The first content of the range to be retrieved. Most recent content has index 0. |
| end | The last content of the range to be retrieved. Oldest content has index of size (use linphone_chat_room_get_media_contents_size() to retrieve size) |
| int linphone_chat_room_get_media_contents_size | ( | LinphoneChatRoom * | chat_room | ) |
Gets the number of media contents (see linphone_chat_room_get_media_contents()).
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which media contents size should be retrieved. |
| bool_t linphone_chat_room_get_muted | ( | const LinphoneChatRoom * | chat_room | ) |
Gets if a chat room has been flagged as muted (not by default).
A muted chat room isn't used to compute unread messages total count.
| chat_room | the LinphoneChatRoom object |
| int linphone_chat_room_get_nb_participants | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the number of participants in the chat room (that is without ourselves).
| chat_room | A LinphoneChatRoom object |
| const LinphoneConferenceParams * linphone_chat_room_get_params | ( | const LinphoneChatRoom * | chat_room | ) |
Returns current parameters associated with the chat room.
This is typically the parameters passed during the LinphoneChatRoom creation process to linphone_core_create_chat_room_7() or some default parameters if no LinphoneChatRoomParams was explicitely passed during LinphoneChatRoom creation.
| chat_room | the LinphoneChatRoom object |
| bctbx_list_t * linphone_chat_room_get_participants | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the list of participants of a chat room.
| chat_room | A LinphoneChatRoom object |
| const LinphoneAddress * linphone_chat_room_get_peer_address | ( | LinphoneChatRoom * | chat_room | ) |
Get the peer address associated to this chat room.
| chat_room | LinphoneChatRoom object. |
| const char * linphone_chat_room_get_remote_composing_content_type | ( | const LinphoneChatRoom * | chat_room | ) |
Returns the content-type (if set) of what the remote is currently composing.
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| LinphoneChatRoomSecurityLevel linphone_chat_room_get_security_level | ( | LinphoneChatRoom * | chat_room | ) |
Gets the security level of a chat room.
| chat_room | A LinphoneChatRoom object |
| LinphoneChatRoomState linphone_chat_room_get_state | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the state of the chat room.
| chat_room | LinphoneChatRoom object |
| const char * linphone_chat_room_get_subject | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the subject of a chat room.
| chat_room | A LinphoneChatRoom object |
| const char * linphone_chat_room_get_subject_utf8 | ( | const LinphoneChatRoom * | chat_room | ) |
Gets the subject of a chat room (as an UTF8 string)
| chat_room | A LinphoneChatRoom object |
| bctbx_list_t * linphone_chat_room_get_unread_history | ( | LinphoneChatRoom * | chat_room | ) |
Gets all unread messages for this chat room, sorted from oldest to most recent.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which messages should be retrieved |
| int linphone_chat_room_get_unread_messages_count | ( | LinphoneChatRoom * | chat_room | ) |
Gets the number of unread messages in the chatroom.
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| void * linphone_chat_room_get_user_data | ( | const LinphoneChatRoom * | chat_room | ) |
Retrieve the user pointer associated with the chat room.
| chat_room | the LinphoneChatRoom object. |
| bool_t linphone_chat_room_has_been_left | ( | const LinphoneChatRoom * | chat_room | ) |
Returns whether or not the chat room has been left.
| chat_room | LinphoneChatRoom object |
| bool_t linphone_chat_room_has_capability | ( | const LinphoneChatRoom * | chat_room, |
| int | mask | ||
| ) |
Checks if a chat room has given capabilities.
| chat_room | A LinphoneChatRoom object |
| mask | a LinphoneChatRoomCapabilitiesMask mask |
| bool_t linphone_chat_room_is_empty | ( | LinphoneChatRoom * | chat_room | ) |
Returns whether or not a LinphoneChatRoom has at least one LinphoneChatMessage or not.
| chat_room | The LinphoneChatRoom object corresponding to the conversation |
| bool_t linphone_chat_room_is_read_only | ( | const LinphoneChatRoom * | chat_room | ) |
Returns whether or not a message can be sent using this chat room.
A chat room may be read only until it's created, or when it's a group you have left.
| chat_room | LinphoneChatRoom object |
| bool_t linphone_chat_room_is_remote_composing | ( | const LinphoneChatRoom * | chat_room | ) |
Tells whether the remote is currently composing a message.
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| void linphone_chat_room_leave | ( | LinphoneChatRoom * | chat_room | ) |
Leaves a chat room.
| chat_room | A LinphoneChatRoom object |
| void linphone_chat_room_mark_as_read | ( | LinphoneChatRoom * | chat_room | ) |
Mark all messages of the conversation as read.
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| void linphone_chat_room_nominate_admin_and_leave | ( | LinphoneChatRoom * | chat_room, |
| const LinphoneAddress * | new_admin | ||
| ) |
Nominates a new admin and then leaves a chat room.
| chat_room | A LinphoneChatRoom object |
| new_admin | The LinphoneAddress of the new admin |
| void linphone_chat_room_notify_participant_device_registration | ( | LinphoneChatRoom * | chat_room, |
| const LinphoneAddress * | participant_device | ||
| ) |
Notifies the chatroom that a participant device has just registered.
This function is meaningful only for server implementation of chatroom, and shall not by used by client applications.
| chat_room | A LinphoneChatRoom object |
| participant_device | list of the participant devices to be used by the group chat room |
| void linphone_chat_room_params_enable_encryption | ( | LinphoneChatRoomParams * | params, |
| bool_t | encrypted | ||
| ) |
Enables or disables encryption for the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| encrypted | TRUE to enable encryption, FALSE to disable. |
| void linphone_chat_room_params_enable_group | ( | LinphoneChatRoomParams * | params, |
| bool_t | group | ||
| ) |
Enables or disables group chat for the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| group | TRUE to enable group chat, FALSE to disable (resulting in one-on-one chat room) |
| void linphone_chat_room_params_enable_rtt | ( | LinphoneChatRoomParams * | params, |
| bool_t | rtt | ||
| ) |
Enables or disables real time text for the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| rtt | TRUE to enable real time text, FALSE to disable. |
| bool_t linphone_chat_room_params_encryption_enabled | ( | const LinphoneChatRoomParams * | params | ) |
Get the encryption status of the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| LinphoneChatRoomBackend linphone_chat_room_params_get_backend | ( | const LinphoneChatRoomParams * | params | ) |
Get the backend implementation of the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| LinphoneChatRoomEncryptionBackend linphone_chat_room_params_get_encryption_backend | ( | const LinphoneChatRoomParams * | params | ) |
Get the encryption implementation of the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| long linphone_chat_room_params_get_ephemeral_lifetime | ( | const LinphoneChatRoomParams * | params | ) |
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.
| params | The LinphoneChatRoomParams object. |
| LinphoneChatRoomEphemeralMode linphone_chat_room_params_get_ephemeral_mode | ( | const LinphoneChatRoomParams * | params | ) |
Get the ephemeral message mode of the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| const char * linphone_chat_room_params_get_subject | ( | const LinphoneChatRoomParams * | params | ) |
Get the subject of the chat room.
| params | The LinphoneChatRoomParams object. |
| bool_t linphone_chat_room_params_group_enabled | ( | const LinphoneChatRoomParams * | params | ) |
Get the group chat status of the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| bool_t linphone_chat_room_params_is_valid | ( | const LinphoneChatRoomParams * | params | ) |
Returns whether the given parameters are valid or not.
| params | The LinphoneChatRoomParams object. |
| LinphoneChatRoomParams * linphone_chat_room_params_new | ( | void | ) |
Returns new chat room parameters.
| LinphoneChatRoomParams * linphone_chat_room_params_ref | ( | LinphoneChatRoomParams * | params | ) |
Acquire a reference to the chat room parameters.
| params | The LinphoneChatRoomParams object. |
| bool_t linphone_chat_room_params_rtt_enabled | ( | const LinphoneChatRoomParams * | params | ) |
Get the real time text status of the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| void linphone_chat_room_params_set_backend | ( | LinphoneChatRoomParams * | params, |
| LinphoneChatRoomBackend | backend | ||
| ) |
Set the backend implementation of these chat room parameters.
| params | The LinphoneChatRoomParams object. |
| backend | The LinphoneChatRoomBackend enum value |
| void linphone_chat_room_params_set_encryption_backend | ( | LinphoneChatRoomParams * | params, |
| LinphoneChatRoomEncryptionBackend | backend | ||
| ) |
Set the encryption backend implementation of these chat room parameters.
| params | The LinphoneChatRoomParams object. |
| backend | The LinphoneChatRoomEncryptionBackend enum value |
| void linphone_chat_room_params_set_ephemeral_lifetime | ( | LinphoneChatRoomParams * | params, |
| 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.
| params | The LinphoneChatRoomParams object. |
| time | The ephemeral lifetime, default is disabled (0) |
| void linphone_chat_room_params_set_ephemeral_mode | ( | LinphoneChatRoomParams * | params, |
| LinphoneChatRoomEphemeralMode | mode | ||
| ) |
Enables or disables forcing of ephemeral messages for the chat room associated with the given parameters.
| params | The LinphoneChatRoomParams object. |
| mode | Ephemeral message mode LinphoneChatRoomEphemeralMode. |
| void linphone_chat_room_params_set_subject | ( | LinphoneChatRoomParams * | params, |
| const char * | subject | ||
| ) |
Set the subject of the chat room.
| params | The LinphoneChatRoomParams object. |
| subject | The subject to set. |
| void linphone_chat_room_params_unref | ( | LinphoneChatRoomParams * | params | ) |
Release reference to the chat room params.
| params | The LinphoneChatRoomParams object. |
| void linphone_chat_room_receive_chat_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Used to receive a chat message when using async mechanism with IM enchat_roomyption engine.
| chat_room | LinphoneChatRoom object |
| message | LinphoneChatMessage object |
| LinphoneChatRoom * linphone_chat_room_ref | ( | LinphoneChatRoom * | chat_room | ) |
Acquire a reference to the chat room.
| chat_room | The LinphoneChatRoom object. |
| void linphone_chat_room_remove_callbacks | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatRoomCbs * | cbs | ||
| ) |
Removes a listener from a LinphoneChatRoom.
| chat_room | LinphoneChatRoom object |
| cbs | LinphoneChatRoomCbs object to remove. |
| void linphone_chat_room_remove_participant | ( | LinphoneChatRoom * | chat_room, |
| LinphoneParticipant * | participant | ||
| ) |
Removes a participant of a chat room.
| chat_room | A LinphoneChatRoom object |
| participant | The participant to remove from the chat room |
| void linphone_chat_room_remove_participants | ( | LinphoneChatRoom * | chat_room, |
| const bctbx_list_t * | participants | ||
| ) |
Removes several participants of a chat room at once.
| chat_room | A LinphoneChatRoom object |
| participants | The participants to remove. |
| void linphone_chat_room_retract_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Deletes the content of a previously sent message for both sender and receivers.
Message will still appear in the conversation history but will be empty. You can still delete it from history using linphone_chat_room_delete_message().
| chat_room | The LinphoneChatRoom object corresponding to the conversation. |
| message | The LinphoneChatMessage object to delete. |
| LinphoneEventLog * linphone_chat_room_search_chat_message_by_text | ( | LinphoneChatRoom * | chat_room, |
| const char * | text, | ||
| const LinphoneEventLog * | from, | ||
| LinphoneSearchDirection | direction | ||
| ) |
Searches chat messages by text.
| chat_room | The LinphoneChatRoom object corresponding to the conversation that will be searched |
| text | The text to search in messages |
| from | The LinphoneEventLog object corresponding to the event where to start the search |
| direction | The LinphoneSearchDirection where to search, LinphoneSearchDirectionUp will search older messages while LinphoneSearchDirectionDown will search newer messages |
| MS2_DEPRECATED void linphone_chat_room_send_chat_message | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatMessage * | message | ||
| ) |
Send a message to peer member of this chat room.
| chat_room | LinphoneChatRoom object |
| message | LinphoneChatMessage object The state of the message sending will be notified via the callbacks defined in the LinphoneChatMessageCbs object that can be obtained by calling linphone_chat_message_get_callbacks(). The LinphoneChatMessage reference is transferred to the function and thus doesn't need to be unref'd by the application. |
| MS2_DEPRECATED void linphone_chat_room_send_message | ( | LinphoneChatRoom * | chat_room, |
| const char * | message | ||
| ) |
Send a message to peer member of this chat room.
| chat_room | LinphoneChatRoom object |
| message | message to be sent |
| void linphone_chat_room_set_conference_address | ( | LinphoneChatRoom * | chat_room, |
| LinphoneAddress * | conference_address | ||
| ) |
Sets the conference address of a group chat room.
This function needs to be called from the LinphoneChatRoomCbsConferenceAddressGenerationCb callback and only there. This function is meaningful only for server implementation of chatroom, and shall not by used by client applications.
| chat_room | A LinphoneChatRoom object |
| conference_address | The conference LinphoneAddress to be used by the group chat room |
| void linphone_chat_room_set_ephemeral_lifetime | ( | LinphoneChatRoom * | chat_room, |
| long | time | ||
| ) |
Sets lifetime (in seconds) for all new ephemeral messages in the chat room.
After the message is read, it will be deleted after "time" seconds.
| chat_room | LinphoneChatRoom object |
| time | The ephemeral lifetime, default is 0 (disabled) |
| void linphone_chat_room_set_ephemeral_mode | ( | LinphoneChatRoom * | chat_room, |
| LinphoneChatRoomEphemeralMode | mode | ||
| ) |
Sets the ephemeral mode of the chat room.
| chat_room | LinphoneChatRoom object |
| mode | The ephemeral mode LinphoneChatRoomEphemeralMode |
| void linphone_chat_room_set_ephemeral_not_read_lifetime | ( | LinphoneChatRoom * | chat_room, |
| long | time | ||
| ) |
Sets not-read lifetime (in seconds) for all new ephemeral messages in the chat room.
If the message is not read, it will be deleted after "time" seconds.
| chat_room | LinphoneChatRoom object |
| time | The ephemeral not-read lifetime, default is 0 (disabled) |
| void linphone_chat_room_set_muted | ( | LinphoneChatRoom * | chat_room, |
| bool_t | muted | ||
| ) |
Sets if a chat room should be considered as muted or not.
A muted chat room isn't used to compute unread messages total count.
| chat_room | the LinphoneChatRoom object |
| muted | TRUE to flag it as muted, FALSE to un-mute it. |
| void linphone_chat_room_set_participant_admin_status | ( | LinphoneChatRoom * | chat_room, |
| LinphoneParticipant * | participant, | ||
| bool_t | is_admin | ||
| ) |
Changes the admin status of a participant of a chat room (you need to be an admin yourself to do this).
| chat_room | A LinphoneChatRoom object |
| participant | The Participant for which to change the admin status |
| is_admin | A boolean value telling whether the participant should now be an admin or not |
| void linphone_chat_room_set_participant_devices | ( | LinphoneChatRoom * | chat_room, |
| LinphoneAddress * | participant_address, | ||
| const bctbx_list_t * | device_identities | ||
| ) |
Sets the list of participant devices in the form of SIP URIs with GRUUs for a given participant.
This function is meaningful only for server implementation of chatroom, and shall not by used by client applications.
| chat_room | A LinphoneChatRoom object |
| participant_address | The participant address |
| device_identities | List of the participant devices to be used by the group chat room |
| void linphone_chat_room_set_subject | ( | LinphoneChatRoom * | chat_room, |
| const char * | subject | ||
| ) |
Sets the subject of a chat room.
| chat_room | A LinphoneChatRoom object |
| subject | The new subject to set for the chat room |
| void linphone_chat_room_set_subject_utf8 | ( | LinphoneChatRoom * | chat_room, |
| const char * | subject | ||
| ) |
Sets the subject of a chat room (utf-8 string).
| chat_room | A LinphoneChatRoom object |
| subject | The new subject to set for the chat room |
| void linphone_chat_room_set_user_data | ( | LinphoneChatRoom * | chat_room, |
| void * | user_data | ||
| ) |
Assign a user pointer to the chat room.
| chat_room | the LinphoneChatRoom object. |
| user_data | The user pointer to associate with the chat room. |
| const char * linphone_chat_room_state_to_string | ( | const LinphoneChatRoomState | state | ) |
Converts a LinphoneChatRoomState enum to a string.
| state | a LinphoneChatRoomState to convert to string |
| void linphone_chat_room_stop_composing | ( | LinphoneChatRoom * | chat_room | ) |
Notifies the destination of the chat message that the user is no longer composing.
| chat_room | The LinphoneChatRoom object corresponding to the conversation for which the composing was stopped. |
| void linphone_chat_room_unref | ( | LinphoneChatRoom * | chat_room | ) |
Release reference to the chat room.
| chat_room | The LinphoneChatRoom object. |
| LinphoneComposingParticipant * linphone_composing_participant_clone | ( | const LinphoneComposingParticipant * | composing_participant | ) |
Clones a composing participant.
| composing_participant | The LinphoneComposingParticipant object to be cloned. |
| const LinphoneAddress * linphone_composing_participant_get_address | ( | const LinphoneComposingParticipant * | composing_participant | ) |
Gets the participant's address.
| composing_participant | The LinphoneComposingParticipant object. |
| const char * linphone_composing_participant_get_content_type | ( | const LinphoneComposingParticipant * | composing_participant | ) |
Gets the content-type of what the participant is being composing.
| composing_participant | The LinphoneComposingParticipant object. |
| LinphoneComposingParticipant * linphone_composing_participant_ref | ( | LinphoneComposingParticipant * | composing_participant | ) |
Takes a reference on a LinphoneComposingParticipant.
| composing_participant | The LinphoneComposingParticipant object. |
| void linphone_composing_participant_unref | ( | LinphoneComposingParticipant * | composing_participant | ) |
Releases a LinphoneComposingParticipant.
| composing_participant | The LinphoneComposingParticipant object. |
| void linphone_core_add_content_type_support | ( | LinphoneCore * | core, |
| const char * | content_type | ||
| ) |
Add support for the specified content type.
It is the application responsibility to handle it correctly afterwards.
| core | LinphoneCore object |
| content_type | The content type to add support for |
| bool_t linphone_core_auto_download_icalendars_enabled | ( | LinphoneCore * | core | ) |
Gets if the automatic download of incoming icalendars is enabled or not.
| core | LinphoneCore object |
| bool_t linphone_core_auto_download_voice_recordings_enabled | ( | LinphoneCore * | core | ) |
Gets if the auto download for incoming voice recordings is enabled or not.
| core | LinphoneCore object |
| bool_t linphone_core_chat_enabled | ( | const LinphoneCore * | core | ) |
Returns whether chat is enabled.
| core | A LinphoneCore object |
| MS2_DEPRECATED LinphoneChatRoomEphemeralMode linphone_core_chat_room_get_default_ephemeral_mode | ( | const LinphoneCore * | core | ) |
Gets the default ephemeral message mode.
| core | the LinphoneCore. |
| MS2_DEPRECATED void linphone_core_chat_room_set_default_ephemeral_mode | ( | LinphoneCore * | core, |
| LinphoneChatRoomEphemeralMode | mode | ||
| ) |
Sets the default ephemeral message mode.
| core | the LinphoneCore. |
| mode | default ephemeral message mode LinphoneChatRoomEphemeralMode |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_chat_room | ( | LinphoneCore * | core, |
| const LinphoneChatRoomParams * | params, | ||
| const LinphoneAddress * | localAddr, | ||
| const char * | subject, | ||
| const bctbx_list_t * | participants | ||
| ) |
Create a chat room.
| core | A LinphoneCore object |
| params | The chat room creation parameters LinphoneChatRoomParams |
| localAddr | LinphoneAddress representing the local proxy configuration to use for the chat room creation |
| subject | The subject of the group chat room |
| participants | The initial list of participants of the chat room |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_chat_room_2 | ( | LinphoneCore * | core, |
| const LinphoneChatRoomParams * | params, | ||
| const char * | subject, | ||
| const bctbx_list_t * | participants | ||
| ) |
Create a chat room.
| core | A LinphoneCore object |
| params | The chat room creation parameters LinphoneChatRoomParams |
| subject | The subject of the group chat room |
| participants | The initial list of participants of the chat room. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_chat_room_3 | ( | LinphoneCore * | core, |
| const char * | subject, | ||
| const bctbx_list_t * | participants | ||
| ) |
| core | A LinphoneCore object |
| subject | The subject of the group chat room |
| participants | The initial list of participants of the chat room. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_chat_room_4 | ( | LinphoneCore * | core, |
| const LinphoneChatRoomParams * | params, | ||
| const LinphoneAddress * | localAddr, | ||
| const LinphoneAddress * | participant | ||
| ) |
| core | A LinphoneCore object |
| params | The chat room creation parameters LinphoneChatRoomParams |
| localAddr | LinphoneAddress representing the local proxy configuration to use for the chat room creation |
| participant | LinphoneAddress representing the initial participant to add to the chat room |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_chat_room_5 | ( | LinphoneCore * | core, |
| const LinphoneAddress * | participant | ||
| ) |
| core | A LinphoneCore object |
| participant | LinphoneAddress representing the initial participant to add to the chat room |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_chat_room_6 | ( | LinphoneCore * | core, |
| const LinphoneChatRoomParams * | params, | ||
| const LinphoneAddress * | localAddr, | ||
| const bctbx_list_t * | participants | ||
| ) |
Create a chat room.
| core | A LinphoneCore object |
| params | The chat room creation parameters LinphoneChatRoomParams |
| localAddr | LinphoneAddress of a local LinphoneAccount identity or NULL |
| participants | The initial list of participants of the chat room. |
| LinphoneChatRoom * linphone_core_create_chat_room_7 | ( | LinphoneCore * | core, |
| const LinphoneConferenceParams * | params, | ||
| const bctbx_list_t * | participants | ||
| ) |
Create a chat room.
| core | A LinphoneCore object |
| params | The chat room creation parameters LinphoneConferenceParams |
| participants | The initial list of participants of the chat room. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_client_group_chat_room | ( | LinphoneCore * | core, |
| const char * | subject, | ||
| bool_t | fallback | ||
| ) |
Create a client-side group chat room.
When calling this function the chat room is only created at the client-side and is empty. You need to call linphone_chat_room_add_participants() to create at the server side and add participants to it. Also, the created chat room will not be a one-on-one chat room even if linphone_chat_room_add_participants() is called with only one participant.
| core | A LinphoneCore object |
| subject | The subject of the group chat room |
| fallback | Boolean value telling whether we should plan on being able to fallback to a basic chat room if the client-side group chat room creation fails |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_create_client_group_chat_room_2 | ( | LinphoneCore * | core, |
| const char * | subject, | ||
| bool_t | fallback, | ||
| bool_t | encrypted | ||
| ) |
Create a client-side group chat room.
When calling this function the chat room is only created at the client-side and is empty. You need to call linphone_chat_room_add_participants() to create at the server side and add participants to it. Also, the created chat room will not be a one-on-one chat room even if linphone_chat_room_add_participants() is called with only one participant.
| core | A LinphoneCore object |
| subject | The subject of the group chat room |
| fallback | Boolean value telling whether we should plan on being able to fallback to a basic chat room if the client-side group chat room creation fails |
| encrypted | Boolean value telling whether we should apply encryption or not on chat messages sent and received on this room. |
| LinphoneChatRoomParams * linphone_core_create_default_chat_room_params | ( | LinphoneCore * | core | ) |
Creates and returns the default chat room parameters.
| core | LinphoneCore object |
| void linphone_core_delete_chat_room | ( | LinphoneCore * | core, |
| LinphoneChatRoom * | chat_room | ||
| ) |
Removes a chatroom including all message history from the LinphoneCore.
| core | A LinphoneCore object |
| chat_room | A LinphoneChatRoom object |
| void linphone_core_disable_chat | ( | LinphoneCore * | core, |
| LinphoneReason | deny_reason | ||
| ) |
Inconditionnaly disables incoming chat messages.
| core | A LinphoneCore object |
| deny_reason | the deny reason (LinphoneReasonNone has no effect). |
| bool_t linphone_core_empty_chatrooms_deletion_enabled | ( | const LinphoneCore * | core | ) |
Tells whether empty chat rooms are deleted or not.
| core | A LinphoneCore object |
| void linphone_core_enable_auto_download_icalendars | ( | LinphoneCore * | core, |
| bool_t | auto_download_icalendars | ||
| ) |
Automatically downloads files attached to a chat message if it's content type matches the one we use for icalendars.
| core | LinphoneCore object |
| auto_download_icalendars | TRUE to automatically download incoming icalendars, FALSE to disable it. |
| void linphone_core_enable_auto_download_voice_recordings | ( | LinphoneCore * | core, |
| bool_t | auto_download_voice_recordings | ||
| ) |
Enables automatic download of files attached to a chat message if it's content type matches the one we use for voice recordings.
| core | LinphoneCore object |
| auto_download_voice_recordings | TRUE to automatically download incoming voice recordings, FALSE to disable it. |
| void linphone_core_enable_chat | ( | LinphoneCore * | core | ) |
Enables reception of incoming chat messages.
By default it is enabled but it can be disabled with linphone_core_disable_chat().
| core | A LinphoneCore object |
| void linphone_core_enable_empty_chatrooms_deletion | ( | LinphoneCore * | core, |
| bool_t | enable | ||
| ) |
Enable the deletion of empty chatrooms (i.e.
chatrooms with no participants)
| core | A LinphoneCore object |
| enable | A boolean value telling whether to enable or disable the deletion of chat rooms with no participants in (Applicable to servers only) it |
| void linphone_core_enable_lime_x3dh | ( | LinphoneCore * | core, |
| bool_t | enable | ||
| ) |
Tells to LinphoneCore to use LIME X3DH.
| core | LinphoneCore object |
| enable | A boolean value telling whether to enable or disable LIME X3DH |
| void linphone_core_enable_send_message_after_notify | ( | LinphoneCore * | core, |
| bool_t | enabled | ||
| ) |
Enable sending of chat message on group chats only after receiving the NOTIFY full state If it is disabled, as it is the default value, message will be sent after the delay set by linphone_core_get_message_sending_delay
| core | LinphoneCore object |
| enabled | TRUE if enabled, FALSE otherwise. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_find_chat_room | ( | const LinphoneCore * | core, |
| const LinphoneAddress * | peer_addr, | ||
| const LinphoneAddress * | local_addr | ||
| ) |
Find a chat room.
No reference is transferred to the application. The LinphoneCore keeps a reference on the chat room.
| core | the LinphoneCore. |
| peer_addr | a linphone address. |
| local_addr | a linphone address. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_find_one_to_one_chat_room | ( | const LinphoneCore * | core, |
| const LinphoneAddress * | local_addr, | ||
| const LinphoneAddress * | participant_addr | ||
| ) |
Find a one-on-one chat room.
No reference is transferred to the application. The LinphoneCore keeps a reference on the chat room.
| core | the LinphoneCore. |
| local_addr | a linphone address. |
| participant_addr | a linphone address. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_find_one_to_one_chat_room_2 | ( | const LinphoneCore * | core, |
| const LinphoneAddress * | local_addr, | ||
| const LinphoneAddress * | participant_addr, | ||
| bool_t | encrypted | ||
| ) |
Find a one-on-one chat room.
No reference is transferred to the application. The LinphoneCore keeps a reference on the chat room.
| core | the LinphoneCore. |
| local_addr | a linphone address. |
| participant_addr | a linphone address. |
| encrypted | whether to look for an encrypted chat room or not |
| bool_t linphone_core_get_chat_messages_aggregation_enabled | ( | LinphoneCore * | core | ) |
End of group ldap.
Returns whether chat messages grouping is enabled or not.
| core | The LinphoneCore object |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_get_chat_room | ( | LinphoneCore * | core, |
| const LinphoneAddress * | addr | ||
| ) |
Get a chat room whose peer is the supplied address.
If it does not exist yet, it will be created as a basic chat room. No reference is transferred to the application. The LinphoneCore keeps a reference on the chat room.
| core | the LinphoneCore. |
| addr | a linphone address. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_get_chat_room_2 | ( | LinphoneCore * | core, |
| const LinphoneAddress * | peer_addr, | ||
| const LinphoneAddress * | local_addr | ||
| ) |
Get a chat room.
If it does not exist yet, it will be created as a basic chat room. No reference is transferred to the application. The LinphoneCore keeps a reference on the chat room.
| core | the LinphoneCore. |
| peer_addr | a linphone address. |
| local_addr | a linphone address. |
| MS2_DEPRECATED LinphoneChatRoom * linphone_core_get_chat_room_from_uri | ( | LinphoneCore * | core, |
| const char * | to | ||
| ) |
Get a chat room for messaging from a sip uri like sip:joe@s.nosp@m.ip.l.nosp@m.inpho.nosp@m.ne.o.nosp@m.rg.
If it does not exist yet, it will be created as a basic chat room. No reference is transferred to the application. The LinphoneCore keeps a reference on the chat room.
| core | A LinphoneCore object |
| to | The destination address for messages. |
| const bctbx_list_t * linphone_core_get_chat_rooms | ( | LinphoneCore * | core | ) |
| long linphone_core_get_default_ephemeral_lifetime | ( | const LinphoneCore * | core | ) |
Gets the default lifetime of ephemeral messages in seconds once they are read.
| core | the LinphoneCore. |
| LinphoneChatRoomEphemeralMode linphone_core_get_default_ephemeral_mode | ( | const LinphoneCore * | core | ) |
Gets the default ephemeral message mode.
| core | the LinphoneCore. |
| long linphone_core_get_default_ephemeral_not_read_lifetime | ( | const LinphoneCore * | core | ) |
Gets the default lifetime of ephemeral messages in seconds when they are not read.
| core | the LinphoneCore. |
| LinphoneEphemeralChatMessagePolicy linphone_core_get_ephemeral_chat_message_policy | ( | const LinphoneCore * | core | ) |
Gets the current policy for ephemeral chat messages.
See LinphoneEphemeralChatMessagePolicy for more details.
| core | the core |
| LinphoneImEncryptionEngine * linphone_core_get_im_encryption_engine | ( | const LinphoneCore * | core | ) |
Gets the IM Encryption Engine in the core if possible.
| core | LinphoneCore object |
| LinphoneImNotifPolicy * linphone_core_get_im_notif_policy | ( | const LinphoneCore * | core | ) |
Gets the LinphoneImNotifPolicy object controlling the instant messaging delivery and displayed service notifications.
| core | LinphoneCore object |
| long linphone_core_get_imdn_resend_period | ( | const LinphoneCore * | core | ) |
Gets the IMDN resend period.
| core | the LinphoneCore. |
| int linphone_core_get_imdn_to_everybody_threshold | ( | const LinphoneCore * | core | ) |
Returns the threshold for sending IMDN to all participants to a LinphoneChatRoom.
| core | A LinphoneCore object |
| int linphone_core_get_max_size_for_auto_download_incoming_files | ( | LinphoneCore * | core | ) |
Gets the size under which incoming files in chat messages will be downloaded automatically.
| core | LinphoneCore object |
| int linphone_core_get_message_automatic_resending_delay | ( | const LinphoneCore * | core | ) |
Returns the duration of the timer that delays the automatic resending of chat messages.
| core | LinphoneCore object |
| int linphone_core_get_message_sending_delay | ( | const LinphoneCore * | core | ) |
Returns the duration of the timer that delays the sending of chat messages.
| core | LinphoneCore object |
| LinphoneChatRoom * linphone_core_get_new_chat_room_from_conf_addr | ( | LinphoneCore * | core, |
| const char * | chat_room_addr | ||
| ) |
Gets the chat room we have been added into using the chat_room_addr included in the push notification body This will start the core given in parameter, iterate until the new chat room is received and return it.
By default, after 25 seconds the function returns because iOS kills the app extension after 30 seconds.
| core | The LinphoneCore |
| chat_room_addr | The sip address of the chat room |
| LinphonePushNotificationMessage * linphone_core_get_new_message_from_callid | ( | LinphoneCore * | core, |
| const char * | call_id | ||
| ) |
Gets the chat message with the call_id included in the push notification body This will start the core given in parameter, iterate until the message is received and return it.
By default, after 25 seconds the function returns because iOS kills the app extension after 30 seconds.
| core | The LinphoneCore |
| call_id | The callId of the Message SIP transaction |
| long linphone_core_get_queued_message_resend_period | ( | const LinphoneCore * | core | ) |
Gets the queued message resend period.
| core | the LinphoneCore. |
| unsigned int linphone_core_get_remaining_download_file_count | ( | LinphoneCore * | core | ) |
Returns how many attachments are yet to be downloaded.
| core | the LinphoneCore. |
| unsigned int linphone_core_get_remaining_upload_file_count | ( | LinphoneCore * | core | ) |
Returns how many attachments are yet to be uploaded.
| core | the LinphoneCore. |
| int linphone_core_get_unread_chat_message_count | ( | const LinphoneCore * | core | ) |
Returns the global unread chat message count.
| core | LinphoneCore object. |
| int linphone_core_get_unread_chat_message_count_from_active_locals | ( | const LinphoneCore * | core | ) |
Returns the unread chat message count for all active local address.
(Primary contact + proxy configs.)
| core | LinphoneCore object. |
| bool_t linphone_core_is_auto_download_icalendars_enabled | ( | LinphoneCore * | core | ) |
Gets if the automatic download of incoming icalendars is enabled or not.
| core | LinphoneCore object |
| bool_t linphone_core_is_auto_download_voice_recordings_enabled | ( | LinphoneCore * | core | ) |
Gets if the auto download for incoming voice recordings is enabled or not.
| core | LinphoneCore object |
| bool_t linphone_core_is_content_type_supported | ( | const LinphoneCore * | core, |
| const char * | content_type | ||
| ) |
Tells whether a content type is supported.
| core | LinphoneCore object |
| content_type | The content type to check |
| bool_t linphone_core_lime_x3dh_available | ( | const LinphoneCore * | core | ) |
Tells if LIME X3DH is available.
| core | LinphoneCore object |
| bool_t linphone_core_lime_x3dh_enabled | ( | const LinphoneCore * | core | ) |
Tells wether LIME X3DH is enabled or not.
| core | LinphoneCore object |
| void linphone_core_remove_content_type_support | ( | LinphoneCore * | core, |
| const char * | content_type | ||
| ) |
Remove support for the specified content type.
It is the application responsibility to handle it correctly afterwards.
| core | LinphoneCore object |
| content_type | The content type to remove support for |
| LinphoneChatRoom * linphone_core_search_chat_room | ( | const LinphoneCore * | core, |
| const LinphoneChatRoomParams * | params, | ||
| const LinphoneAddress * | localAddr, | ||
| const LinphoneAddress * | remoteAddr, | ||
| const bctbx_list_t * | participants | ||
| ) |
Find a chat room.
| core | A LinphoneCore object |
| params | The chat room parameters to match LinphoneChatRoomParams or NULL |
| localAddr | LinphoneAddress of a local LinphoneAccount identity or NULL |
| remoteAddr | LinphoneAddress to search for or NULL |
| participants | The participants that must be present in the chat room to find. |
| LinphoneChatRoom * linphone_core_search_chat_room_2 | ( | const LinphoneCore * | core, |
| const LinphoneConferenceParams * | params, | ||
| const LinphoneAddress * | localAddr, | ||
| const LinphoneAddress * | remoteAddr, | ||
| const bctbx_list_t * | participants | ||
| ) |
Find a chat room.
| core | A LinphoneCore object |
| params | The chat room parameters to match LinphoneChatRoomParams or NULL |
| localAddr | LinphoneAddress of a local LinphoneAccount identity or NULL |
| remoteAddr | LinphoneAddress to search for or NULL |
| participants | The participants that must be present in the chat room to find. |
| LinphoneChatRoom * linphone_core_search_chat_room_by_identifier | ( | const LinphoneCore * | core, |
| const char * | identifier | ||
| ) |
Find a chat room by its identifier.
| core | A LinphoneCore object |
| identifier | The chat room identifier |
| bool_t linphone_core_send_message_after_notify_enabled | ( | const LinphoneCore * | core | ) |
Returns enablement of sending chat messages on group chats after receiving the NOTIFY full state.
| core | LinphoneCore object |
| void linphone_core_set_auto_download_icalendars_enabled | ( | LinphoneCore * | core, |
| bool_t | auto_download_icalendars | ||
| ) |
Automatically downloads files attached to a chat message if it's content type matches the one we use for icalendars.
| core | LinphoneCore object |
| auto_download_icalendars | TRUE to automatically download incoming icalendars, FALSE to disable it. |
| void linphone_core_set_auto_download_voice_recordings_enabled | ( | LinphoneCore * | core, |
| bool_t | auto_download_voice_recordings | ||
| ) |
Enables automatic download of files attached to a chat message if it's content type matches the one we use for voice recordings.
| core | LinphoneCore object |
| auto_download_voice_recordings | TRUE to automatically download incoming voice recordings, FALSE to disable it. |
| void linphone_core_set_chat_messages_aggregation_enabled | ( | LinphoneCore * | core, |
| bool_t | enabled | ||
| ) |
Sets whether chat messages grouping is enabled or not.
This optimisation is turned on by default. It allows to receive bulks of incoming message faster, and notify them to the application in a row. Set [sip] chat_messages_aggregation in your configuration file for the timer, default is 500ms.
| core | The LinphoneCore object |
| enabled | TRUE to wait for chat messages and notify them as at once, FALSE to keep legacy behavior. |
| void linphone_core_set_default_ephemeral_lifetime | ( | LinphoneCore * | core, |
| long | value | ||
| ) |
Set the default ephemeral lifetime in seconds once read.
| core | the LinphoneCore. |
| value | lifetime of ephemeral messages in seconds once read |
| void linphone_core_set_default_ephemeral_mode | ( | LinphoneCore * | core, |
| LinphoneChatRoomEphemeralMode | mode | ||
| ) |
Sets the default ephemeral message mode.
| core | the LinphoneCore. |
| mode | default ephemeral message mode LinphoneChatRoomEphemeralMode |
| void linphone_core_set_default_ephemeral_not_read_lifetime | ( | LinphoneCore * | core, |
| long | value | ||
| ) |
Set the default ephemeral lifetime in seconds when not read.
| core | the LinphoneCore. |
| value | lifetime of ephemeral messages in seconds when not read |
| void linphone_core_set_ephemeral_chat_message_policy | ( | LinphoneCore * | core, |
| LinphoneEphemeralChatMessagePolicy | policy | ||
| ) |
Sets the policy for ephemeral chat messages.
See LinphoneEphemeralChatMessagePolicy for more details.
| core | the core |
| policy | the LinphoneEphemeralChatMessagePolicy to use. |
| void linphone_core_set_im_encryption_engine | ( | LinphoneCore * | core, |
| LinphoneImEncryptionEngine * | imee | ||
| ) |
Sets an IM Encryption Engine in the core.
| core | LinphoneCore object |
| imee | LinphoneImEncryptionEngine object |
| void linphone_core_set_imdn_resend_period | ( | LinphoneCore * | core, |
| long | seconds | ||
| ) |
Set the IMDN resend period.
It is the number of seconds after the first attempt to send, an IMDN message is sent again on startup if failed earlier on
| core | the LinphoneCore. |
| seconds | number of seconds after the first attempt to send an IMDN, it is retried at startup. A negative value means all IMDNs are resent at startup. |
| void linphone_core_set_imdn_to_everybody_threshold | ( | LinphoneCore * | core, |
| int | threshold | ||
| ) |
Sets the threshold for sending IMDN to all participants to a LinphoneChatRoom.
| core | A LinphoneCore object |
| threshold | the threshold for sending IMDN to all participants to a LinphoneChatRoom |
| void linphone_core_set_max_size_for_auto_download_incoming_files | ( | LinphoneCore * | core, |
| int | size | ||
| ) |
Sets the size under which incoming files in chat messages will be downloaded automatically.
| core | LinphoneCore object |
| size | The size in bytes, -1 to disable the autodownload feature, 0 to download them all no matter the size |
| void linphone_core_set_message_automatic_resending_delay | ( | LinphoneCore * | core, |
| int | duration | ||
| ) |
It sets the duration of the timer to resend a message when the channel is broken (i.e.
the core gets an NoResponse or IOError response)
| core | LinphoneCore object |
| duration | the duration of the timer in seconds. A 0 or negative number means that the feature is deactivated. |
| 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.
| core | LinphoneCore object |
| duration | the duration of the timer in seconds. A 0 or negative number deactivates the feature. |
linphone_core_send_message_after_notify_enabled returns false | void linphone_core_set_queued_message_resend_period | ( | LinphoneCore * | core, |
| long | seconds | ||
| ) |
Set the queued message resend period.
It is the number of seconds after the first attempt to send the message.
| core | the LinphoneCore. |
| seconds | number of seconds after the first attempt to send a message. A negative value means all queued messages are resent at startup. |
| 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
| policy | LinphoneImNotifPolicy object. |
| void linphone_im_notif_policy_enable_all | ( | LinphoneImNotifPolicy * | policy | ) |
Enable all receiving and sending of notifications.
| 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.
| policy | LinphoneImNotifPolicy object |
| 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.
| policy | LinphoneImNotifPolicy object |
| bool_t linphone_im_notif_policy_get_recv_imdn_displayed | ( | const LinphoneImNotifPolicy * | policy | ) |
Tell whether imdn displayed notifications are being notified when received.
| policy | LinphoneImNotifPolicy object |
| bool_t linphone_im_notif_policy_get_recv_is_composing | ( | const LinphoneImNotifPolicy * | policy | ) |
Tell whether is_composing notifications are being notified when received.
| policy | LinphoneImNotifPolicy object |
| bool_t linphone_im_notif_policy_get_send_imdn_delivered | ( | const LinphoneImNotifPolicy * | policy | ) |
Tell whether imdn delivered notifications are being sent.
| policy | LinphoneImNotifPolicy object |
| bool_t linphone_im_notif_policy_get_send_imdn_delivery_error | ( | const LinphoneImNotifPolicy * | policy | ) |
Tell whether imdn delivery error notifications are being sent.
| policy | LinphoneImNotifPolicy object |
| bool_t linphone_im_notif_policy_get_send_imdn_displayed | ( | const LinphoneImNotifPolicy * | policy | ) |
Tell whether imdn displayed notifications are being sent.
| policy | LinphoneImNotifPolicy object |
| bool_t linphone_im_notif_policy_get_send_is_composing | ( | const LinphoneImNotifPolicy * | policy | ) |
Tell whether is_composing notifications are being sent.
| policy | LinphoneImNotifPolicy object |
| void * linphone_im_notif_policy_get_user_data | ( | const LinphoneImNotifPolicy * | policy | ) |
Retrieve the user pointer associated with the LinphoneImNotifPolicy object.
| policy | LinphoneImNotifPolicy object. |
| LinphoneImNotifPolicy * linphone_im_notif_policy_ref | ( | LinphoneImNotifPolicy * | policy | ) |
Acquire a reference to the LinphoneImNotifPolicy object.
| policy | LinphoneImNotifPolicy object. |
| void linphone_im_notif_policy_set_recv_imdn_delivered | ( | LinphoneImNotifPolicy * | policy, |
| bool_t | enable | ||
| ) |
Enable imdn delivered notifications receiving.
| 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
| 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.
| 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.
| 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.
| 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
| 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.
| 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.
| 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.
| 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.
| policy | LinphoneImNotifPolicy object. |
1.9.8