Functions
LinphoneChatMessage *	linphone_chat_message_ref (LinphoneChatMessage *message)
	Acquires a reference to the chat message. More...

void	linphone_chat_message_unref (LinphoneChatMessage *message)
	Releases reference to the chat message. More...

void *	linphone_chat_message_get_user_data (const LinphoneChatMessage *message)
	Retrieves the user pointer associated with the chat message. More...

void	linphone_chat_message_set_user_data (LinphoneChatMessage message, void user_data)
	Assigns a user pointer to the chat message. More...

LinphoneCore *	linphone_chat_message_get_core (const LinphoneChatMessage *message)
	Returns back pointer to LinphoneCore object. More...

const char *	linphone_chat_message_get_external_body_url (const LinphoneChatMessage *message)
	Messages can carry external body as defined by rfc2017. More...

void	linphone_chat_message_set_external_body_url (LinphoneChatMessage message, const char external_body_url)
	Messages can carry external body as defined by rfc2017. More...

time_t	linphone_chat_message_get_time (const LinphoneChatMessage *message)
	Gets the time the message was sent. More...

bool_t	linphone_chat_message_is_outgoing (const LinphoneChatMessage *message)
	Returns wehther the message has been sent or received. More...

const LinphoneAddress *	linphone_chat_message_get_from_address (const LinphoneChatMessage *message)
	Gets origin of the message. More...

const LinphoneAddress *	linphone_chat_message_get_to_address (const LinphoneChatMessage *message)
	Gets destination of the message. More...

const char *	linphone_chat_message_get_content_type (const LinphoneChatMessage *message)
	Gets the content type of a chat message. More...

void	linphone_chat_message_set_content_type (LinphoneChatMessage message, const char content_type)
	Sets the content type of a chat message. More...

const char *	linphone_chat_message_get_utf8_text (const LinphoneChatMessage *message)
	Gets text part of this message. More...

int	linphone_chat_message_set_utf8_text (LinphoneChatMessage message, const char text)
	Sets a text to be sent, given as a string of UTF-8 characters. More...

const char *	linphone_chat_message_get_message_id (const LinphoneChatMessage *message)
	Get the message identifier. More...

const char *	linphone_chat_message_get_appdata (const LinphoneChatMessage *message)
	Linphone message has an app-specific field that can store a text. More...

void	linphone_chat_message_set_appdata (LinphoneChatMessage message, const char data)
	Linphone message has an app-specific field that can store a text. More...

LinphoneChatRoom *	linphone_chat_message_get_chat_room (const LinphoneChatMessage *message)
	Returns the chatroom this message belongs to. More...

bool_t	linphone_chat_message_get_to_be_stored (const LinphoneChatMessage *message)
	Gets if a chat message is to be stored. More...

void	linphone_chat_message_set_to_be_stored (LinphoneChatMessage *message, bool_t to_be_stored)
	Sets if a chat message is to be stored. More...

unsigned int	linphone_chat_message_store (LinphoneChatMessage *message)

LinphoneChatMessageState	linphone_chat_message_get_state (const LinphoneChatMessage *message)
	Gets the state of the message. More...

bool_t	linphone_chat_message_is_secured (const LinphoneChatMessage *message)
	Gets if the message was end-to-end encrypted when transferred. More...

LinphoneContent *	linphone_chat_message_get_file_transfer_information (const LinphoneChatMessage *message)
	Gets the file transfer information (used by callbacks to recover informations during a rcs file transfer) More...

bool_t	linphone_chat_message_download_content (LinphoneChatMessage message, LinphoneContent content)
	Starts the download of the LinphoneContent referenced in the LinphoneChatMessage from remote server. More...

bool_t	linphone_chat_message_download_contents (LinphoneChatMessage *message)
	Starts the download of all the LinphoneContent objects representing file transfers included in the message (linphone_content_is_file_transfer() method returns TRUE). More...

void	linphone_chat_message_cancel_file_transfer (LinphoneChatMessage *message)
	Cancels an ongoing file transfer attached to this message (upload or download). More...

void	linphone_chat_message_send (LinphoneChatMessage *message)
	Sends a chat message. More...

const LinphoneAddress *	linphone_chat_message_get_peer_address (const LinphoneChatMessage *message)
	Returns the peer (remote) address of the message. More...

const LinphoneAddress *	linphone_chat_message_get_local_address (const LinphoneChatMessage *message)
	Returns the local address the message was sent or received with. More...

void	linphone_chat_message_add_custom_header (LinphoneChatMessage message, const char header_name, const char *header_value)
	Adds custom headers to the message. More...

const char *	linphone_chat_message_get_custom_header (const LinphoneChatMessage message, const char header_name)
	Retrieves a custom header value given its name. More...

void	linphone_chat_message_remove_custom_header (LinphoneChatMessage message, const char header_name)
	Removes a custom header from the message. More...

bool_t	linphone_chat_message_is_read (const LinphoneChatMessage *message)
	Returns wether the message has been read or not. More...

void	linphone_chat_message_mark_as_read (LinphoneChatMessage *message)
	Marks the message as read. More...

LinphoneReason	linphone_chat_message_get_reason (const LinphoneChatMessage *message)

const LinphoneErrorInfo *	linphone_chat_message_get_error_info (const LinphoneChatMessage *message)
	Gets full details about delivery error of a chat message. More...

bool_t	linphone_chat_message_is_forward (LinphoneChatMessage *message)
	Returns wether the chat message is a forward message or not. More...

const char *	linphone_chat_message_get_forward_info (const LinphoneChatMessage *message)
	Gets the forward info if available as a string. More...

bool_t	linphone_chat_message_is_reply (LinphoneChatMessage *message)
	Returns wether the chat message is a reply message or not. More...

const char *	linphone_chat_message_get_reply_message_id (LinphoneChatMessage *message)
	Returns the ID of the message this is a reply to. More...

const LinphoneAddress *	linphone_chat_message_get_reply_message_sender_address (LinphoneChatMessage *message)
	Returns the address of the sender of the message this is a reply to. More...

LinphoneChatMessage *	linphone_chat_message_get_reply_message (LinphoneChatMessage *message)
	Returns the LinphoneChatMessage this message is a reply to. More...

bool_t	linphone_chat_message_is_ephemeral (const LinphoneChatMessage *message)
	Returns wether the chat message is an ephemeral message or not. More...

long	linphone_chat_message_get_ephemeral_lifetime (const LinphoneChatMessage *message)
	Returns lifetime of an ephemeral message. More...

time_t	linphone_chat_message_get_ephemeral_expire_time (const LinphoneChatMessage *message)
	Returns the real time at which an ephemeral message expires and will be deleted. More...

LinphoneStatus	linphone_chat_message_put_char (LinphoneChatMessage *message, uint32_t character)
	Fulfills a chat message character by character and send the character immediately as real-time text (RFC4103 / T.140) or as Baudot tones. More...

void	linphone_chat_message_add_callbacks (LinphoneChatMessage message, LinphoneChatMessageCbs cbs)
	Adds a listener in order to be notified of LinphoneChatMessage events. More...

void	linphone_chat_message_remove_callbacks (LinphoneChatMessage message, LinphoneChatMessageCbs cbs)
	Removes a listener from a LinphoneChatMessage. More...

LinphoneChatMessageCbs *	linphone_chat_message_get_current_callbacks (const LinphoneChatMessage *message)
	Gets the current LinphoneChatMessageCbs being invoked, if any. More...

void	linphone_chat_message_add_file_content (LinphoneChatMessage message, LinphoneContent content)
	Adds a file content to the ChatMessage. More...

void	linphone_chat_message_add_utf8_text_content (LinphoneChatMessage message, const char text)
	Creates a LinphoneContent of type text/plain with the provided string, and attach it to the message. More...

void	linphone_chat_message_add_content (LinphoneChatMessage message, LinphoneContent content)
	Adds a content to the ChatMessage. More...

void	linphone_chat_message_remove_content (LinphoneChatMessage message, LinphoneContent content)
	Removes a content from the ChatMessage. More...

const bctbx_list_t *	linphone_chat_message_get_contents (const LinphoneChatMessage *message)
	Returns the list of contents in the message. More...

bool_t	linphone_chat_message_is_file_transfer_in_progress (const LinphoneChatMessage *message)
	Gets whether or not a file is currently being downloaded or uploaded. More...

bctbx_list_t *	linphone_chat_message_get_participants_by_imdn_state (const LinphoneChatMessage *message, LinphoneChatMessageState state)
	Gets the list of participants for which the imdn state has reached the specified state and the time at which they did. More...

const char *	linphone_chat_message_get_call_id (const LinphoneChatMessage *message)
	Gets the SIP call-id accociated with the message. More...

bctbx_list_t *	linphone_chat_message_get_reactions (const LinphoneChatMessage *message)
	Gets the list of reactions received for this chat message. More...

const LinphoneChatMessageReaction *	linphone_chat_message_get_own_reaction (const LinphoneChatMessage *message)
	Returns our own reaction for a given chat message, if any. More...

bool_t	linphone_chat_message_has_conference_invitation_content (const LinphoneChatMessage *message)
	Returns wether the chat message has a conference invitation content or not. More...

LinphoneChatMessageReaction *	linphone_chat_message_create_reaction (LinphoneChatMessage message, const char utf8_reaction)
	Creates a emoji reaction for the given chat mesage. More...

bool_t	linphone_chat_message_has_text_content (const LinphoneChatMessage *message)
	Returns wether the chat message has a text content or not. More...

MS2_DEPRECATED const char *	linphone_chat_message_get_text (const LinphoneChatMessage *message)
	Get text part of this message. More...

MS2_DEPRECATED const char *	linphone_chat_message_get_file_transfer_filepath (const LinphoneChatMessage *message)
	Get the path to the file to read from or write to during the file transfer. More...

MS2_DEPRECATED void	linphone_chat_message_start_file_download (LinphoneChatMessage message, LinphoneChatMessageStateChangedCb status_cb, void user_data)
	Start the download of the file from remote server. More...

MS2_DEPRECATED bool_t	linphone_chat_message_download_file (LinphoneChatMessage *message)
	Start the download of the file referenced in a LinphoneChatMessage from remote server. More...

MS2_DEPRECATED void	linphone_chat_message_set_file_transfer_filepath (LinphoneChatMessage message, const char filepath)
	Set the path to the file to read from or write to during the file transfer. More...

MS2_DEPRECATED LinphoneChatMessageCbs *	linphone_chat_message_get_callbacks (const LinphoneChatMessage *message)
	Get the LinphoneChatMessageCbs object associated with the LinphoneChatMessage. More...

MS2_DEPRECATED int	linphone_chat_message_set_text (LinphoneChatMessage message, const char text)
	Set a chat message text to be sent by linphone_chat_room_send_message() More...

MS2_DEPRECATED const char *	linphone_chat_message_get_text_content (const LinphoneChatMessage *message)
	Gets the text content if available as a string. More...

MS2_DEPRECATED void	linphone_chat_message_add_text_content (LinphoneChatMessage message, const char text)
	Creates a LinphoneContent of type PlainText with the given text as body. More...

MS2_DEPRECATED bool_t	linphone_chat_message_is_file_transfer (const LinphoneChatMessage *message)
	Return whether or not a chat message is a file transfer. More...

MS2_DEPRECATED bool_t	linphone_chat_message_is_text (const LinphoneChatMessage *message)
	Return whether or not a chat message is a text. More...

Detailed Description

Function Documentation

◆ linphone_chat_message_add_callbacks()

void linphone_chat_message_add_callbacks	(	LinphoneChatMessage *	message,
		LinphoneChatMessageCbs *	cbs
	)

Adds a listener in order to be notified of LinphoneChatMessage events.

Parameters

message	LinphoneChatMessage object to monitor.
cbs	A LinphoneChatMessageCbs object holding the callbacks you need.

◆ linphone_chat_message_add_content()

void linphone_chat_message_add_content	(	LinphoneChatMessage *	message,
		LinphoneContent *	content
	)

Adds a content to the ChatMessage.

Parameters

message	LinphoneChatMessage object.
content	the LinphoneContent object to add.

◆ linphone_chat_message_add_custom_header()

void linphone_chat_message_add_custom_header	(	LinphoneChatMessage *	message,
		const char *	header_name,
		const char *	header_value
	)

Adds custom headers to the message.

Parameters

message	LinphoneChatMessage object.
header_name	name of the header
header_value	header value

◆ linphone_chat_message_add_file_content()

void linphone_chat_message_add_file_content	(	LinphoneChatMessage *	message,
		LinphoneContent *	content
	)

Adds a file content to the ChatMessage.

Parameters

message	LinphoneChatMessage object.
content	the LinphoneContent object to add.

◆ linphone_chat_message_add_text_content()

MS2_DEPRECATED void linphone_chat_message_add_text_content	(	LinphoneChatMessage *	message,
		const char *	text
	)

Creates a LinphoneContent of type PlainText with the given text as body.

Parameters

message	LinphoneChatMessage object.
text	The text in System Locale to add to the message.

Deprecated:: 01/07/2020. Use linphone_chat_message_add_utf8_text_content() instead.

◆ linphone_chat_message_add_utf8_text_content()

void linphone_chat_message_add_utf8_text_content	(	LinphoneChatMessage *	message,
		const char *	text
	)

Creates a LinphoneContent of type text/plain with the provided string, and attach it to the message.

Parameters

message	LinphoneChatMessage object.
text	The text to add to the message.

◆ linphone_chat_message_cancel_file_transfer()

void linphone_chat_message_cancel_file_transfer ( LinphoneChatMessage * message )

Cancels an ongoing file transfer attached to this message (upload or download).

Parameters

message LinphoneChatMessage object.

◆ linphone_chat_message_create_reaction()

LinphoneChatMessageReaction* linphone_chat_message_create_reaction	(	LinphoneChatMessage *	message,
		const char *	utf8_reaction
	)

Creates a emoji reaction for the given chat mesage.

To send it, use linphone_chat_message_reaction_send().

Parameters

message	the message you want to react on
utf8_reaction	the emoji character(s) as UTF-8.

Returns: a LinphoneChatMessageReaction object.

◆ linphone_chat_message_download_content()

bool_t linphone_chat_message_download_content	(	LinphoneChatMessage *	message,
		LinphoneContent *	content
	)

Starts the download of the LinphoneContent referenced in the LinphoneChatMessage from remote server.

Parameters

message	LinphoneChatMessage object.
content	the LinphoneContent object to download (must have the linphone_content_is_file_transfer() method return TRUE).

Returns: FALSE if there is an error, TRUE otherwise.

◆ linphone_chat_message_download_contents()

bool_t linphone_chat_message_download_contents ( LinphoneChatMessage * message )

Starts the download of all the LinphoneContent objects representing file transfers included in the message (linphone_content_is_file_transfer() method returns TRUE).

Parameters

message LinphoneChatMessage object.

Returns: FALSE if there is an error, TRUE otherwise.

◆ linphone_chat_message_download_file()

MS2_DEPRECATED bool_t linphone_chat_message_download_file ( LinphoneChatMessage * message )

Start the download of the file referenced in a LinphoneChatMessage from remote server.

Parameters

message LinphoneChatMessage object.

Deprecated:: 12/07/2018 Use linphone_chat_message_download_content() instead

◆ linphone_chat_message_get_appdata()

const char* linphone_chat_message_get_appdata ( const LinphoneChatMessage * message )

Linphone message has an app-specific field that can store a text.

The application might want to use it for keeping data over restarts, like thumbnail image path.

Parameters

message LinphoneChatMessage object.

Returns: the application-specific data or NULL if none has been stored.

◆ linphone_chat_message_get_call_id()

const char* linphone_chat_message_get_call_id ( const LinphoneChatMessage * message )

Gets the SIP call-id accociated with the message.

Parameters

message LinphoneChatMessage object.

Returns: the call-id

◆ linphone_chat_message_get_callbacks()

MS2_DEPRECATED LinphoneChatMessageCbs* linphone_chat_message_get_callbacks ( const LinphoneChatMessage * message )

Get the LinphoneChatMessageCbs object associated with the LinphoneChatMessage.

Parameters

message LinphoneChatMessage object.

Returns: The LinphoneChatMessageCbs object associated with the LinphoneChatMessage.

Deprecated:: 19/02/2019

◆ linphone_chat_message_get_chat_room()

LinphoneChatRoom* linphone_chat_message_get_chat_room ( const LinphoneChatMessage * message )

Returns the chatroom this message belongs to.

Parameters

message LinphoneChatMessage object.

Returns: the LinphoneChatRoom in which this message has been sent or received.

◆ linphone_chat_message_get_content_type()

const char* linphone_chat_message_get_content_type ( const LinphoneChatMessage * message )

Gets the content type of a chat message.

Parameters

message LinphoneChatMessage object.

Returns: The content type of the chat message

◆ linphone_chat_message_get_contents()

const bctbx_list_t* linphone_chat_message_get_contents ( const LinphoneChatMessage * message )

Returns the list of contents in the message.

Parameters

message LinphoneChatMessage object.

Returns: The list of LinphoneContent.

◆ linphone_chat_message_get_core()

LinphoneCore* linphone_chat_message_get_core ( const LinphoneChatMessage * message )

Returns back pointer to LinphoneCore object.

Parameters

message LinphoneChatMessage object.

Returns: the LinphoneCore object associated with this message.

◆ linphone_chat_message_get_current_callbacks()

LinphoneChatMessageCbs* linphone_chat_message_get_current_callbacks ( const LinphoneChatMessage * message )

Gets the current LinphoneChatMessageCbs being invoked, if any.

This is meant only to be called from a callback to be able to get the user_data associated with the LinphoneChatMessageCbs that is calling the callback.

Parameters

message LinphoneChatMessage object

Returns: The LinphoneChatMessageCbs that has called the last callback.

◆ linphone_chat_message_get_custom_header()

const char* linphone_chat_message_get_custom_header	(	const LinphoneChatMessage *	message,
		const char *	header_name
	)

Retrieves a custom header value given its name.

Parameters

message	LinphoneChatMessage object.
header_name	header name searched

Returns: the custom header value or NULL if not found.

◆ linphone_chat_message_get_ephemeral_expire_time()

time_t linphone_chat_message_get_ephemeral_expire_time ( const LinphoneChatMessage * message )

Returns the real time at which an ephemeral message expires and will be deleted.

See also: linphone_chat_message_is_ephemeral()

Parameters

message LinphoneChatMessage object.

Returns: the time at which an ephemeral message expires. 0 means the message has not been read.

◆ linphone_chat_message_get_ephemeral_lifetime()

long linphone_chat_message_get_ephemeral_lifetime ( const LinphoneChatMessage * message )

Returns lifetime of an ephemeral message.

The lifetime is the duration after which the ephemeral message will disappear once viewed.

See also: linphone_chat_message_is_ephemeral()

Parameters

message LinphoneChatMessage object.

Returns: the lifetime of an ephemeral message, by default 0 (disabled).

◆ linphone_chat_message_get_error_info()

const LinphoneErrorInfo* linphone_chat_message_get_error_info ( const LinphoneChatMessage * message )

Gets full details about delivery error of a chat message.

Parameters

message LinphoneChatMessage object.

Returns: a LinphoneErrorInfo describing the details.

◆ linphone_chat_message_get_external_body_url()

const char* linphone_chat_message_get_external_body_url ( const LinphoneChatMessage * message )

Messages can carry external body as defined by rfc2017.

Parameters

message LinphoneChatMessage object.

Returns: external body url or NULL if not present.

◆ linphone_chat_message_get_file_transfer_filepath()

MS2_DEPRECATED const char* linphone_chat_message_get_file_transfer_filepath ( const LinphoneChatMessage * message )

Get the path to the file to read from or write to during the file transfer.

Parameters

message LinphoneChatMessage object

Returns: The path to the file to use for the file transfer.

Deprecated:: 12/07/2018 use linphone_content_get_file_path() instead.

◆ linphone_chat_message_get_file_transfer_information()

LinphoneContent* linphone_chat_message_get_file_transfer_information ( const LinphoneChatMessage * message )

Gets the file transfer information (used by callbacks to recover informations during a rcs file transfer)

Parameters

message LinphoneChatMessage object.

Returns: a pointer to the LinphoneContent structure or NULL if not present.

◆ linphone_chat_message_get_forward_info()

const char* linphone_chat_message_get_forward_info ( const LinphoneChatMessage * message )

Gets the forward info if available as a string.

Parameters

message LinphoneChatMessage object.

Returns: the original sender of the message if it has been forwarded, NULL otherwise.

◆ linphone_chat_message_get_from_address()

const LinphoneAddress* linphone_chat_message_get_from_address ( const LinphoneChatMessage * message )

Gets origin of the message.

Parameters

message LinphoneChatMessage object.

Returns: the LinphoneAddress of the sender.

◆ linphone_chat_message_get_local_address()

const LinphoneAddress* linphone_chat_message_get_local_address ( const LinphoneChatMessage * message )

Returns the local address the message was sent or received with.

Parameters

message LinphoneChatMessage object.

Returns: the LinphoneAddress of the local address used to send/receive this message.

◆ linphone_chat_message_get_message_id()

const char* linphone_chat_message_get_message_id ( const LinphoneChatMessage * message )

Get the message identifier.

It is used to identify a message so that it can be notified as delivered and/or displayed.

Parameters

message LinphoneChatMessage object.

Returns: The message identifier.

◆ linphone_chat_message_get_own_reaction()

const LinphoneChatMessageReaction* linphone_chat_message_get_own_reaction ( const LinphoneChatMessage * message )

Returns our own reaction for a given chat message, if any.

Parameters

message LinphoneChatMessage object.

Returns: Our own LinphoneChatMessageReaction for that message if any, NULL otherwise.

◆ linphone_chat_message_get_participants_by_imdn_state()

bctbx_list_t* linphone_chat_message_get_participants_by_imdn_state	(	const LinphoneChatMessage *	message,
		LinphoneChatMessageState	state
	)

Gets the list of participants for which the imdn state has reached the specified state and the time at which they did.

Parameters

message	LinphoneChatMessage object.
state	The LinphoneChatMessageState the imdn have reached (only use LinphoneChatMessageStateDelivered, LinphoneChatMessageStateDeliveredToUser, LinphoneChatMessageStateDisplayed and LinphoneChatMessageStateNotDelivered)

Returns: The list of participants.

◆ linphone_chat_message_get_peer_address()

const LinphoneAddress* linphone_chat_message_get_peer_address ( const LinphoneChatMessage * message )

Returns the peer (remote) address of the message.

Parameters

message the LinphoneChatMessage object

Returns: the LinphoneAddress of the peer address used to send/receive this message.

◆ linphone_chat_message_get_reactions()

bctbx_list_t* linphone_chat_message_get_reactions ( const LinphoneChatMessage * message )

Gets the list of reactions received for this chat message.

Warning: list is ordered by content of reaction message, not by received timestamp!

Parameters

message LinphoneChatMessage object.

Returns: The sorted list of reaction if any.

◆ linphone_chat_message_get_reply_message()

LinphoneChatMessage* linphone_chat_message_get_reply_message ( LinphoneChatMessage * message )

Returns the LinphoneChatMessage this message is a reply to.

Parameters

message LinphoneChatMessage object.

Returns: the original message LinphoneChatMessage.

◆ linphone_chat_message_get_reply_message_id()

const char* linphone_chat_message_get_reply_message_id ( LinphoneChatMessage * message )

Returns the ID of the message this is a reply to.

Parameters

message LinphoneChatMessage object.

Returns: the original message id.

◆ linphone_chat_message_get_reply_message_sender_address()

const LinphoneAddress* linphone_chat_message_get_reply_message_sender_address ( LinphoneChatMessage * message )

Returns the address of the sender of the message this is a reply to.

Parameters

message LinphoneChatMessage object.

Returns: the original message sender LinphoneAddress.

◆ linphone_chat_message_get_state()

LinphoneChatMessageState linphone_chat_message_get_state ( const LinphoneChatMessage * message )

Gets the state of the message.

Parameters

message LinphoneChatMessage object.

Returns: the current LinphoneChatMessageState of the message.

◆ linphone_chat_message_get_text()

MS2_DEPRECATED const char* linphone_chat_message_get_text ( const LinphoneChatMessage * message )

Get text part of this message.

Parameters

message LinphoneChatMessage object.

Returns: text or NULL if no text.

Deprecated:: 07/11/2017 use linphone_chat_message_get_utf8_text() instead

◆ linphone_chat_message_get_text_content()

MS2_DEPRECATED const char* linphone_chat_message_get_text_content ( const LinphoneChatMessage * message )

Gets the text content if available as a string.

Parameters

message LinphoneChatMessage object.

Returns: the LinphoneContent buffer if available in System Locale, null otherwise.

Deprecated:: 01/07/2020. Use linphone_chat_message_get_utf8_text() instead.

◆ linphone_chat_message_get_time()

time_t linphone_chat_message_get_time ( const LinphoneChatMessage * message )

Gets the time the message was sent.

Parameters

message LinphoneChatMessage object.

Returns: the timestamp of when the message was sent.

◆ linphone_chat_message_get_to_address()

const LinphoneAddress* linphone_chat_message_get_to_address ( const LinphoneChatMessage * message )

Gets destination of the message.

Parameters

message LinphoneChatMessage object.

Returns: the LinphoneAddress of the recipient.

◆ linphone_chat_message_get_to_be_stored()

bool_t linphone_chat_message_get_to_be_stored ( const LinphoneChatMessage * message )

Gets if a chat message is to be stored.

Parameters

message LinphoneChatMessage object.

Returns: Whether or not the message is to be stored

◆ linphone_chat_message_get_user_data()

void* linphone_chat_message_get_user_data ( const LinphoneChatMessage * message )

Retrieves the user pointer associated with the chat message.

Parameters

message LinphoneChatMessage object.

Returns: The user pointer associated with the chat message.

◆ linphone_chat_message_get_utf8_text()

const char* linphone_chat_message_get_utf8_text ( const LinphoneChatMessage * message )

Gets text part of this message.

Parameters

message LinphoneChatMessage object.

Returns: The text as UTF8 characters or NULL if no text.

◆ linphone_chat_message_has_conference_invitation_content()

bool_t linphone_chat_message_has_conference_invitation_content ( const LinphoneChatMessage * message )

Returns wether the chat message has a conference invitation content or not.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if it has one, FALSE otherwise.

◆ linphone_chat_message_has_text_content()

bool_t linphone_chat_message_has_text_content ( const LinphoneChatMessage * message )

Returns wether the chat message has a text content or not.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if it has one, FALSE otherwise.

Deprecated:: 27/10/2020. Check if linphone_chat_message_get_contents() contains a LinphoneContent for which it's content type is PlainText.

◆ linphone_chat_message_is_ephemeral()

bool_t linphone_chat_message_is_ephemeral ( const LinphoneChatMessage * message )

Returns wether the chat message is an ephemeral message or not.

An ephemeral message will automatically disappear from the recipient's screen after the message has been viewed.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if it is an ephemeral message, FALSE otherwise

◆ linphone_chat_message_is_file_transfer()

MS2_DEPRECATED bool_t linphone_chat_message_is_file_transfer ( const LinphoneChatMessage * message )

Return whether or not a chat message is a file transfer.

Parameters

message LinphoneChatMessage object

Returns: Whether or not the message is a file transfer

Deprecated:: 06/07/2020 check if linphone_chat_message_get_contents() contains a LinphoneContent for which linphone_content_is_file_transfer() returns TRUE.

◆ linphone_chat_message_is_file_transfer_in_progress()

bool_t linphone_chat_message_is_file_transfer_in_progress ( const LinphoneChatMessage * message )

Gets whether or not a file is currently being downloaded or uploaded.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if download or upload is in progress, FALSE otherwise

◆ linphone_chat_message_is_forward()

bool_t linphone_chat_message_is_forward ( LinphoneChatMessage * message )

Returns wether the chat message is a forward message or not.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if it is a forward message, FALSE otherwise

◆ linphone_chat_message_is_outgoing()

bool_t linphone_chat_message_is_outgoing ( const LinphoneChatMessage * message )

Returns wehther the message has been sent or received.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if message has been sent, FALSE if it has been received.

◆ linphone_chat_message_is_read()

bool_t linphone_chat_message_is_read ( const LinphoneChatMessage * message )

Returns wether the message has been read or not.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if message has been marked as read, FALSE otherwise.

◆ linphone_chat_message_is_reply()

bool_t linphone_chat_message_is_reply ( LinphoneChatMessage * message )

Returns wether the chat message is a reply message or not.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if it is a reply message, FALSE otherwise

◆ linphone_chat_message_is_secured()

bool_t linphone_chat_message_is_secured ( const LinphoneChatMessage * message )

Gets if the message was end-to-end encrypted when transferred.

Parameters

message LinphoneChatMessage object.

Returns: TRUE if the message was end-to-end encrypted when transferred, FALSE otherwise.

◆ linphone_chat_message_is_text()

MS2_DEPRECATED bool_t linphone_chat_message_is_text ( const LinphoneChatMessage * message )

Return whether or not a chat message is a text.

Parameters

message LinphoneChatMessage object.

Returns: Whether or not the message is a text

Deprecated:: 06/07/2020 check if linphone_chat_message_get_contents() contains a LinphoneContent with a PlainText content type.

◆ linphone_chat_message_mark_as_read()

void linphone_chat_message_mark_as_read ( LinphoneChatMessage * message )

Marks the message as read.

Only triggers LinphoneChatRoomCbsChatRoomReadCb if it was the last unread message.

Parameters

message LinphoneChatMessage object to mark as read.

◆ linphone_chat_message_put_char()

LinphoneStatus linphone_chat_message_put_char	(	LinphoneChatMessage *	message,
		uint32_t	character
	)

Fulfills a chat message character by character and send the character immediately as real-time text (RFC4103 / T.140) or as Baudot tones.

The method used to send the character depends on if real-time text is enabled or not. If it is, real-time text is of course used, otherwise Baudot will be used if it is enabled in the LinphoneCore (see linphone_core_enable_baudot()). If real-time text is used, the LinphoneChatRoom the message was created from must be a real-time text capable chat room: it must be obtained by placing or receiving a call with real-time text capabilities (see linphone_call_params_enable_realtime_text() ), and getting the LinphoneChatRoom interface from the call with linphone_call_get_chat_room(). When the message is terminated (ie a new line needs to be started), use linphone_chat_message_send() in order to trigger the sending of the new line character and have the full message (comprising all characters sent so far) stored in local database.

Parameters

message	LinphoneChatMessage object.
character	The character to send (T.140 char for real-time text).

Returns: 0 if succeed.

◆ linphone_chat_message_ref()

LinphoneChatMessage* linphone_chat_message_ref ( LinphoneChatMessage * message )

Acquires a reference to the chat message.

Parameters

message LinphoneChatMessage object.

Returns: The same LinphoneChatMessage object.

◆ linphone_chat_message_remove_callbacks()

void linphone_chat_message_remove_callbacks	(	LinphoneChatMessage *	message,
		LinphoneChatMessageCbs *	cbs
	)

Removes a listener from a LinphoneChatMessage.

Parameters

message	LinphoneChatMessage object
cbs	LinphoneChatMessageCbs object to remove.

◆ linphone_chat_message_remove_content()

void linphone_chat_message_remove_content	(	LinphoneChatMessage *	message,
		LinphoneContent *	content
	)

Removes a content from the ChatMessage.

Parameters

message	LinphoneChatMessage object.
content	the LinphoneContent object to remove.

◆ linphone_chat_message_remove_custom_header()

void linphone_chat_message_remove_custom_header	(	LinphoneChatMessage *	message,
		const char *	header_name
	)

Removes a custom header from the message.

Parameters

message	LinphoneChatMessage object.
header_name	name of the header to remove

◆ linphone_chat_message_send()

void linphone_chat_message_send ( LinphoneChatMessage * message )

Sends a chat message.

Parameters

message LinphoneChatMessage object.

◆ linphone_chat_message_set_appdata()

void linphone_chat_message_set_appdata	(	LinphoneChatMessage *	message,
		const char *	data
	)

Linphone message has an app-specific field that can store a text.

The application might want to use it for keeping data over restarts, like thumbnail image path.

Invoking this function will attempt to update the message storage to reflect the change if it is enabled.

Parameters

message	LinphoneChatMessage object.
data	the data to store into the message.

◆ linphone_chat_message_set_content_type()

void linphone_chat_message_set_content_type	(	LinphoneChatMessage *	message,
		const char *	content_type
	)

Sets the content type of a chat message.

This content type must match a content that is text representable, such as text/plain, text/html or image/svg+xml.

Parameters

message	LinphoneChatMessage object.
content_type	The new content type of the chat message

◆ linphone_chat_message_set_external_body_url()

void linphone_chat_message_set_external_body_url	(	LinphoneChatMessage *	message,
		const char *	external_body_url
	)

Messages can carry external body as defined by rfc2017.

Parameters

message	LinphoneChatMessage object.
external_body_url	ex: access-type=URL; URL="http://www.foo.com/file"

◆ linphone_chat_message_set_file_transfer_filepath()

MS2_DEPRECATED void linphone_chat_message_set_file_transfer_filepath	(	LinphoneChatMessage *	message,
		const char *	filepath
	)

Set the path to the file to read from or write to during the file transfer.

Parameters

message	LinphoneChatMessage object.
filepath	The path to the file to use for the file transfer.

Deprecated:: 12/07/2018 use linphone_content_set_file_path() instead.

◆ linphone_chat_message_set_text()

MS2_DEPRECATED int linphone_chat_message_set_text	(	LinphoneChatMessage *	message,
		const char *	text
	)

Set a chat message text to be sent by linphone_chat_room_send_message()

Parameters

message	LinphoneChatMessage
text	The text is in System Locale.

Returns: 0 if succeed.

Deprecated:: 01/07/2020. Use linphone_chat_message_set_utf8_text() instead.

◆ linphone_chat_message_set_to_be_stored()

void linphone_chat_message_set_to_be_stored	(	LinphoneChatMessage *	message,
		bool_t	to_be_stored
	)

Sets if a chat message is to be stored.

This content type must match a content that is text representable, such as text/plain, text/html or image/svg+xml.

Parameters

message	LinphoneChatMessage object.
to_be_stored	Whether or not the chat message is to be stored

◆ linphone_chat_message_set_user_data()

void linphone_chat_message_set_user_data	(	LinphoneChatMessage *	message,
		void *	user_data
	)

Assigns a user pointer to the chat message.

Parameters

message	LinphoneChatMessage object.
user_data	The user pointer to associate with the chat message.

◆ linphone_chat_message_set_utf8_text()

int linphone_chat_message_set_utf8_text	(	LinphoneChatMessage *	message,
		const char *	text
	)

Sets a text to be sent, given as a string of UTF-8 characters.

Parameters

message	LinphoneChatMessage
text	The text in UTF8 to set.

Returns: 0 if succeed.

◆ linphone_chat_message_start_file_download()

MS2_DEPRECATED void linphone_chat_message_start_file_download	(	LinphoneChatMessage *	message,
		LinphoneChatMessageStateChangedCb	status_cb,
		void *	user_data
	)

Start the download of the file from remote server.

Parameters

message	LinphoneChatMessage object.
status_cb	#LinphoneChatMessageStateChangeCb status callback invoked when file is downloaded or could not be downloaded
user_data	user data

Deprecated:: 21/09/2017 Use linphone_chat_message_download_file() instead.

◆ linphone_chat_message_unref()

void linphone_chat_message_unref ( LinphoneChatMessage * message )

Releases reference to the chat message.

Parameters

message LinphoneChatMessage object.

Functions

Detailed Description

Function Documentation

◆ linphone_chat_message_add_callbacks()

◆ linphone_chat_message_add_content()

◆ linphone_chat_message_add_custom_header()

◆ linphone_chat_message_add_file_content()

◆ linphone_chat_message_add_text_content()

◆ linphone_chat_message_add_utf8_text_content()

◆ linphone_chat_message_cancel_file_transfer()

◆ linphone_chat_message_create_reaction()

◆ linphone_chat_message_download_content()

◆ linphone_chat_message_download_contents()

◆ linphone_chat_message_download_file()

◆ linphone_chat_message_get_appdata()

◆ linphone_chat_message_get_call_id()

◆ linphone_chat_message_get_callbacks()

◆ linphone_chat_message_get_chat_room()

◆ linphone_chat_message_get_content_type()

◆ linphone_chat_message_get_contents()

◆ linphone_chat_message_get_core()

◆ linphone_chat_message_get_current_callbacks()

◆ linphone_chat_message_get_custom_header()

◆ linphone_chat_message_get_ephemeral_expire_time()

◆ linphone_chat_message_get_ephemeral_lifetime()

◆ linphone_chat_message_get_error_info()

◆ linphone_chat_message_get_external_body_url()

◆ linphone_chat_message_get_file_transfer_filepath()

◆ linphone_chat_message_get_file_transfer_information()

◆ linphone_chat_message_get_forward_info()

◆ linphone_chat_message_get_from_address()

◆ linphone_chat_message_get_local_address()

◆ linphone_chat_message_get_message_id()

◆ linphone_chat_message_get_own_reaction()

◆ linphone_chat_message_get_participants_by_imdn_state()

◆ linphone_chat_message_get_peer_address()

◆ linphone_chat_message_get_reactions()

◆ linphone_chat_message_get_reply_message()

◆ linphone_chat_message_get_reply_message_id()

◆ linphone_chat_message_get_reply_message_sender_address()

◆ linphone_chat_message_get_state()

◆ linphone_chat_message_get_text()

◆ linphone_chat_message_get_text_content()

◆ linphone_chat_message_get_time()

◆ linphone_chat_message_get_to_address()

◆ linphone_chat_message_get_to_be_stored()

◆ linphone_chat_message_get_user_data()

◆ linphone_chat_message_get_utf8_text()

◆ linphone_chat_message_has_conference_invitation_content()

◆ linphone_chat_message_has_text_content()

◆ linphone_chat_message_is_ephemeral()

◆ linphone_chat_message_is_file_transfer()

◆ linphone_chat_message_is_file_transfer_in_progress()

◆ linphone_chat_message_is_forward()

◆ linphone_chat_message_is_outgoing()

◆ linphone_chat_message_is_read()

◆ linphone_chat_message_is_reply()

◆ linphone_chat_message_is_secured()

◆ linphone_chat_message_is_text()

◆ linphone_chat_message_mark_as_read()

◆ linphone_chat_message_put_char()

◆ linphone_chat_message_ref()

◆ linphone_chat_message_remove_callbacks()

◆ linphone_chat_message_remove_content()

◆ linphone_chat_message_remove_custom_header()

◆ linphone_chat_message_send()

◆ linphone_chat_message_set_appdata()

◆ linphone_chat_message_set_content_type()

◆ linphone_chat_message_set_external_body_url()

◆ linphone_chat_message_set_file_transfer_filepath()

◆ linphone_chat_message_set_text()

◆ linphone_chat_message_set_to_be_stored()

◆ linphone_chat_message_set_user_data()

◆ linphone_chat_message_set_utf8_text()

◆ linphone_chat_message_start_file_download()

◆ linphone_chat_message_unref()