telepathy-glib API Reference Manual: Text channels

Text channels

Text channels — client-side wrappers for the Text channel type, and the Chat State and Password interfaces

Functions

TpProxyPendingCall *	tp_cli_channel_type_text_call_acknowledge_pending_messages ()
TpProxyPendingCall *	tp_cli_channel_type_text_call_send_message ()
void	(*tp_cli_channel_type_text_callback_for_acknowledge_pending_messages) ()
void	(*tp_cli_channel_type_text_callback_for_send_message) ()
TpProxySignalConnection *	tp_cli_channel_type_text_connect_to_message_received ()
TpProxySignalConnection *	tp_cli_channel_type_text_connect_to_message_sent ()
void	(*tp_cli_channel_type_text_signal_callback_message_received) ()
void	(*tp_cli_channel_type_text_signal_callback_message_sent) ()
TpProxySignalConnection *	tp_cli_channel_type_text_connect_to_pending_messages_removed ()
void	(*tp_cli_channel_type_text_signal_callback_pending_messages_removed) ()
TpProxyPendingCall *	tp_cli_channel_interface_chat_state1_call_set_chat_state ()
void	(*tp_cli_channel_interface_chat_state1_callback_for_set_chat_state) ()
TpProxySignalConnection *	tp_cli_channel_interface_chat_state1_connect_to_chat_state_changed ()
void	(*tp_cli_channel_interface_chat_state1_signal_callback_chat_state_changed) ()
TpProxyPendingCall *	tp_cli_channel_interface_password1_call_get_password_flags ()
TpProxyPendingCall *	tp_cli_channel_interface_password1_call_provide_password ()
void	(*tp_cli_channel_interface_password1_callback_for_get_password_flags) ()
void	(*tp_cli_channel_interface_password1_callback_for_provide_password) ()
TpProxySignalConnection *	tp_cli_channel_interface_password1_connect_to_password_flags_changed ()
void	(*tp_cli_channel_interface_password1_signal_callback_password_flags_changed) ()
TpProxySignalConnection *	tp_cli_channel_interface_sms1_connect_to_sms_channel_changed ()
void	(*tp_cli_channel_interface_sms1_signal_callback_sms_channel_changed) ()
TpProxyPendingCall *	tp_cli_channel_interface_sms1_call_get_sms_length ()
void	(*tp_cli_channel_interface_sms1_callback_for_get_sms_length) ()

Object Hierarchy

Includes

#include <telepathy-glib/telepathy-glib-dbus.h>

Description

A major use for instant messaging is obviously to send messages. Channels of type Text represent IM conversations or chat rooms.

This section documents the auto-generated C wrappers for the Text channel type, and also for the Chat State and Password interfaces, which are usually used in conjunction with Text channels.

Functions

tp_cli_channel_type_text_call_acknowledge_pending_messages ()

TpProxyPendingCall *
tp_cli_channel_type_text_call_acknowledge_pending_messages
                               (TpChannel *proxy,
                                gint timeout_ms,
                                const GArray *in_IDs,
                                tp_cli_channel_type_text_callback_for_acknowledge_pending_messages callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a AcknowledgePendingMessages method call.

Inform the channel that you have handled messages by displaying them to the user (or equivalent), so they can be removed from the pending queue.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_IDs	Used to pass an 'in' argument: The IDs of the messages to acknowledge
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_channel_type_text_call_send_message ()

TpProxyPendingCall *
tp_cli_channel_type_text_call_send_message
                               (TpChannel *proxy,
                                gint timeout_ms,
                                const GPtrArray *in_Message,
                                guint in_Flags,
                                tp_cli_channel_type_text_callback_for_send_message callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a SendMessage method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Submit a message to the server for sending. If this method returns successfully, the message has been submitted to the server and the <tp:member-ref>MessageSent</tp:member-ref> signal is emitted. This method MUST return before the MessageSent signal is emitted. <tp:rationale> This means that the process sending the message is the first to see the <tp:type>Protocol_Message_Token</tp:type>, and can relate the message to the corresponding <tp:member-ref>MessageSent</tp:member-ref> signal by comparing message tokens (if supported by the protocol). </tp:rationale> If this method fails, message submission to the server has failed and no signal on this interface (or the Text interface) is emitted. If this method succeeds, message submission to the server has succeeded, but the message has not necessarily reached its intended recipient. If a delivery failure is detected later, this is signalled by receiving a message whose <code>message-type</code> header maps to <tp:value-ref type="Channel_Text_Message_Type">Delivery_Report</tp:value-ref>. Similarly, if delivery is detected to have been successful (which is not possible in all protocols), a successful delivery report will be signalled.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Message	Used to pass an 'in' argument: The message content, including any attachments or alternatives. This MUST NOT include the following headers, or any others that do not make sense for a client to specify: <code>message-sender</code>, <code>message-sender-id</code>, <code>message-sent</code>, <code>message-received</code>, <code>pending-message-id</code>.
in_Flags	Used to pass an 'in' argument: Flags affecting how the message is sent. The channel MAY ignore some or all flags, depending on <tp:member-ref>DeliveryReportingSupport</tp:member-ref>; the flags that were handled by the CM are provided in <tp:member-ref>MessageSent</tp:member-ref>. (TpMessageSendingFlags)
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_channel_type_text_callback_for_acknowledge_pending_messages ()

void
(*tp_cli_channel_type_text_callback_for_acknowledge_pending_messages)
                               (TpChannel *proxy,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a AcknowledgePendingMessages method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_channel_type_text_callback_for_send_message ()

void
(*tp_cli_channel_type_text_callback_for_send_message)
                               (TpChannel *proxy,
                                const gchar *out_Token,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a SendMessage method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
out_Token	Used to return an 'out' argument if `error` is `NULL`: An opaque token used to match any incoming delivery or failure reports against this message, or an empty string if the message is not readily identifiable.
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_channel_type_text_connect_to_message_received ()

TpProxySignalConnection *
tp_cli_channel_type_text_connect_to_message_received
                               (TpChannel *proxy,
                                tp_cli_channel_type_text_signal_callback_message_received callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal MessageReceived.

Signals that a message has been received and added to the pending messages queue.

Parameters

proxy	A TpChannel or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_channel_type_text_connect_to_message_sent ()

TpProxySignalConnection *
tp_cli_channel_type_text_connect_to_message_sent
                               (TpChannel *proxy,
                                tp_cli_channel_type_text_signal_callback_message_sent callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal MessageSent.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Signals that a message has been submitted for sending. This SHOULD be emitted as soon as the CM determines it's theoretically possible to send the message (e.g. the parameters are supported and correct). <tp:rationale> This signal allows a process that is not the caller of SendMessage to log sent messages. </tp:rationale>

Parameters

proxy	A TpChannel or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_channel_type_text_signal_callback_message_received ()

void
(*tp_cli_channel_type_text_signal_callback_message_received)
                               (TpChannel *proxy,
                                const GPtrArray *arg_Message,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal MessageReceived.

Parameters

proxy	The proxy on which `tp_cli_channel_type_text_connect_to_message_received()` was called
arg_Message	<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The message content, including any attachments or alternatives. If the incoming message contains formatted text without a plain text alternative, the connection manager MUST generate a <tt>text/plain</tt> alternative from the formatted text, and include it in this message (both here, and in the <tp:member-ref>PendingMessages</tp:member-ref> property).</p>
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

tp_cli_channel_type_text_signal_callback_message_sent ()

void
(*tp_cli_channel_type_text_signal_callback_message_sent)
                               (TpChannel *proxy,
                                const GPtrArray *arg_Content,
                                guint arg_Flags,
                                const gchar *arg_Message_Token,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal MessageSent.

Parameters

proxy	The proxy on which `tp_cli_channel_type_text_connect_to_message_sent()` was called
arg_Content	<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The message content (see <tp:type>Message_Part</tp:type> for full details). If the message that was passed to <tp:member-ref>SendMessage</tp:member-ref> has a formatted text part that the connection manager recognises, but no <tt>text/plain</tt> alternative, the CM MUST use the formatted text part to generate a <tt>text/plain</tt> alternative which is also included in this signal argument.</p> <p>The connection manager SHOULD include the <code>message-sender</code>, <code>message-sender-id</code> and <code>message-sent</code> headers in the representation of the message that is signalled here. If the channel has channel-specific handles, the <code>message-sender</code> and <code>message-sender-id</code> SHOULD reflect the sender that other contacts will see.</p> <p>If the connection manager can predict that the message will be altered during transmission, this argument SHOULD reflect what other contacts will receive, rather than being a copy of the argument to SendMessage (if the message is truncated, formatting or alternatives are dropped, etc., then the edited version SHOULD appear in this signal).</p>
arg_Flags	<p>Flags affecting how the message was sent. The flags might be a subset of those passed to SendMessage if the caller requested unsupported flags.</p> (TpMessageSendingFlags)
arg_Message_Token	An opaque token used to match any incoming delivery or failure reports against this message, or an empty string if the message is not readily identifiable.
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

tp_cli_channel_type_text_connect_to_pending_messages_removed ()

TpProxySignalConnection *
tp_cli_channel_type_text_connect_to_pending_messages_removed
                               (TpChannel *proxy,
                                tp_cli_channel_type_text_signal_callback_pending_messages_removed callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal PendingMessagesRemoved.

The messages with the given IDs have been removed from the <tp:member-ref>PendingMessages</tp:member-ref> list. Clients SHOULD NOT attempt to acknowledge those messages. <tp:rationale> This completes change notification for the PendingMessages property (previously, there was change notification when pending messages were added, but not when they were removed). </tp:rationale>

Parameters

proxy	A TpChannel or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_channel_type_text_signal_callback_pending_messages_removed ()

void
(*tp_cli_channel_type_text_signal_callback_pending_messages_removed)
                               (TpChannel *proxy,
                                const GArray *arg_Message_IDs,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal PendingMessagesRemoved.

Parameters

proxy	The proxy on which `tp_cli_channel_type_text_connect_to_pending_messages_removed()` was called
arg_Message_IDs	The messages that have been removed from the pending message list.
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

tp_cli_channel_interface_chat_state1_call_set_chat_state ()

TpProxyPendingCall *
tp_cli_channel_interface_chat_state1_call_set_chat_state
                               (TpChannel *proxy,
                                gint timeout_ms,
                                guint in_State,
                                tp_cli_channel_interface_chat_state1_callback_for_set_chat_state callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a SetChatState method call.

Set the local state and notify other members of the channel that it has changed.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_State	Used to pass an 'in' argument: The new state. (TpChannelChatState)
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_channel_interface_chat_state1_callback_for_set_chat_state ()

void
(*tp_cli_channel_interface_chat_state1_callback_for_set_chat_state)
                               (TpChannel *proxy,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a SetChatState method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_channel_interface_chat_state1_connect_to_chat_state_changed ()

TpProxySignalConnection *
tp_cli_channel_interface_chat_state1_connect_to_chat_state_changed
                               (TpChannel *proxy,
                                tp_cli_channel_interface_chat_state1_signal_callback_chat_state_changed callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal ChatStateChanged.

Emitted when the state of a member of the channel has changed. This includes local state.

Parameters

proxy	A TpChannel or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_channel_interface_chat_state1_signal_callback_chat_state_changed ()

void
(*tp_cli_channel_interface_chat_state1_signal_callback_chat_state_changed)
                               (TpChannel *proxy,
                                guint arg_Contact,
                                guint arg_State,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal ChatStateChanged.

Parameters

proxy	The proxy on which `tp_cli_channel_interface_chat_state1_connect_to_chat_state_changed()` was called
arg_Contact	An integer handle for the contact. (TpContactHandle)
arg_State	The new state of this contact. (TpChannelChatState)
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

tp_cli_channel_interface_password1_call_get_password_flags ()

TpProxyPendingCall *
tp_cli_channel_interface_password1_call_get_password_flags
                               (TpChannel *proxy,
                                gint timeout_ms,
                                tp_cli_channel_interface_password1_callback_for_get_password_flags callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a GetPasswordFlags method call.

Returns the bitwise-OR of the flags relevant to the password on this channel. The user interface can use this to present information about which operations are currently valid.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_channel_interface_password1_call_provide_password ()

TpProxyPendingCall *
tp_cli_channel_interface_password1_call_provide_password
                               (TpChannel *proxy,
                                gint timeout_ms,
                                const gchar *in_Password,
                                tp_cli_channel_interface_password1_callback_for_provide_password callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a ProvidePassword method call.

Provide the password so that the channel can be joined. Must be called with the correct password in order for channel joining to proceed if the 'provide' password flag is set.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Password	Used to pass an 'in' argument: The password
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_channel_interface_password1_callback_for_get_password_flags ()

void
(*tp_cli_channel_interface_password1_callback_for_get_password_flags)
                               (TpChannel *proxy,
                                guint out_Password_Flags,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a GetPasswordFlags method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
out_Password_Flags	Used to return an 'out' argument if `error` is `NULL`: An integer with the logical OR of all the flags set (values of ChannelPasswordFlags) (TpChannelPasswordFlags)
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_channel_interface_password1_callback_for_provide_password ()

void
(*tp_cli_channel_interface_password1_callback_for_provide_password)
                               (TpChannel *proxy,
                                gboolean out_Correct,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a ProvidePassword method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
out_Correct	Used to return an 'out' argument if `error` is `NULL`: A boolean indicating whether or not the password was correct
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_channel_interface_password1_connect_to_password_flags_changed ()

TpProxySignalConnection *
tp_cli_channel_interface_password1_connect_to_password_flags_changed
                               (TpChannel *proxy,
                                tp_cli_channel_interface_password1_signal_callback_password_flags_changed callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal PasswordFlagsChanged.

Emitted when the flags as returned by <tp:member-ref>GetPasswordFlags</tp:member-ref> are changed. The user interface should be updated as appropriate.

Parameters

proxy	A TpChannel or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_channel_interface_password1_signal_callback_password_flags_changed ()

void
(*tp_cli_channel_interface_password1_signal_callback_password_flags_changed)
                               (TpChannel *proxy,
                                guint arg_Added,
                                guint arg_Removed,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal PasswordFlagsChanged.

Parameters

proxy	The proxy on which `tp_cli_channel_interface_password1_connect_to_password_flags_changed()` was called
arg_Added	A bitwise OR of the flags which have been set (TpChannelPasswordFlags)
arg_Removed	A bitwise OR of the flags which have been cleared (TpChannelPasswordFlags)
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

tp_cli_channel_interface_sms1_connect_to_sms_channel_changed ()

TpProxySignalConnection *
tp_cli_channel_interface_sms1_connect_to_sms_channel_changed
                               (TpChannel *proxy,
                                tp_cli_channel_interface_sms1_signal_callback_sms_channel_changed callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal SMSChannelChanged.

This signal indicates a change in the <tp:member-ref>SMSChannel</tp:member-ref> property.

Parameters

proxy	A TpChannel or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_channel_interface_sms1_signal_callback_sms_channel_changed ()

void
(*tp_cli_channel_interface_sms1_signal_callback_sms_channel_changed)
                               (TpChannel *proxy,
                                gboolean arg_SMSChannel,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal SMSChannelChanged.

Parameters

proxy	The proxy on which `tp_cli_channel_interface_sms1_connect_to_sms_channel_changed()` was called
arg_SMSChannel	The new value for <tp:member-ref>SMSChannel</tp:member-ref>.
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

tp_cli_channel_interface_sms1_call_get_sms_length ()

TpProxyPendingCall *
tp_cli_channel_interface_sms1_call_get_sms_length
                               (TpChannel *proxy,
                                gint timeout_ms,
                                const GPtrArray *in_Message,
                                tp_cli_channel_interface_sms1_callback_for_get_sms_length callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a GetSMSLength method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Returns the number of 140 octet chunks required to send a message via SMS, as well as the number of remaining characters available in the final chunk and, if possible, an estimate of the cost. <tp:rationale> There are a number of different SMS encoding mechanisms, and the client doesn't know which mechanisms an individual CM might support. This method allows the client, without any knowledge of the encoding mechanism, to provide length details to the user. </tp:rationale> Clients SHOULD limit the frequency with which this method is called and SHOULD NOT call it for every keystroke. Clients MAY estimate the remaining size between single keystrokes.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Message	Used to pass an 'in' argument: The message the user wishes to send.
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_channel_interface_sms1_callback_for_get_sms_length ()

void
(*tp_cli_channel_interface_sms1_callback_for_get_sms_length)
                               (TpChannel *proxy,
                                guint out_Chunks_Required,
                                gint out_Remaining_Characters,
                                gint out_Estimated_Cost,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a GetSMSLength method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
out_Chunks_Required	Used to return an 'out' argument if `error` is `NULL`: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The number of 140 octet chunks required to send this message.</p> <p>For example, in the GSM standard 7-bit encoding, a 162 character message would require 2 chunks.</p>
out_Remaining_Characters	Used to return an 'out' argument if `error` is `NULL`: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The number of further characters that can be fit in the final chunk. A negative value indicates that the message will be truncated by <code>abs(Remaining_Characters)</code>. The value <code>MIN_INT32</code> (<code>-2<sup>31</sup></code>) indicates the message will be truncated by an unknown amount.</p> <p>For example, in the GSM standard 7-bit encoding, a 162 character message would return 144 remaining characters (because of the space required for the multipart SMS header).</p>
out_Estimated_Cost	Used to return an 'out' argument if `error` is `NULL`: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The estimated cost of sending this message. The currency and scale of this value are the same as the <tp:dbus-ref namespace="imt1.Connection.Interface">Balance1.AccountBalance</tp:dbus-ref> property.</p> <p>A value of <code>-1</code> indicates the cost could not be estimated.</p>
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

Text channels

Functions

Object Hierarchy

Includes

Description

Functions

tp_cli_channel_type_text_call_acknowledge_pending_messages ()

Parameters

Returns

tp_cli_channel_type_text_call_send_message ()

Parameters

Returns

tp_cli_channel_type_text_callback_for_acknowledge_pending_messages ()

Parameters

tp_cli_channel_type_text_callback_for_send_message ()

Parameters

tp_cli_channel_type_text_connect_to_message_received ()

Parameters

Returns

tp_cli_channel_type_text_connect_to_message_sent ()

Parameters

Returns

tp_cli_channel_type_text_signal_callback_message_received ()

Parameters

tp_cli_channel_type_text_signal_callback_message_sent ()

Parameters

tp_cli_channel_type_text_connect_to_pending_messages_removed ()

Parameters

Returns

tp_cli_channel_type_text_signal_callback_pending_messages_removed ()

Parameters

tp_cli_channel_interface_chat_state1_call_set_chat_state ()

Parameters

Returns

tp_cli_channel_interface_chat_state1_callback_for_set_chat_state ()

Parameters

tp_cli_channel_interface_chat_state1_connect_to_chat_state_changed ()

Parameters

Returns

tp_cli_channel_interface_chat_state1_signal_callback_chat_state_changed ()

Parameters

tp_cli_channel_interface_password1_call_get_password_flags ()

Parameters

Returns

tp_cli_channel_interface_password1_call_provide_password ()

Parameters

Returns

tp_cli_channel_interface_password1_callback_for_get_password_flags ()

Parameters

tp_cli_channel_interface_password1_callback_for_provide_password ()

Parameters

tp_cli_channel_interface_password1_connect_to_password_flags_changed ()

Parameters

Returns

tp_cli_channel_interface_password1_signal_callback_password_flags_changed ()

Parameters

tp_cli_channel_interface_sms1_connect_to_sms_channel_changed ()

Parameters

Returns

tp_cli_channel_interface_sms1_signal_callback_sms_channel_changed ()

Parameters

tp_cli_channel_interface_sms1_call_get_sms_length ()

Parameters

Returns

tp_cli_channel_interface_sms1_callback_for_get_sms_length ()

Parameters

Types and Values

See Also