tp_channel_new ()

TpChannel *
tp_channel_new (TpConnection *conn,
                const gchar *object_path,
                const gchar *optional_channel_type,
                TpHandleType optional_handle_type,
                TpHandle optional_handle,
                GError **error);

Since: 0.7.1

tp_channel_new_from_properties ()

TpChannel *
tp_channel_new_from_properties (TpConnection *conn,
                                const gchar *object_path,
                                const GHashTable *immutable_properties,
                                GError **error);

Since: 0.7.19

tp_channel_run_until_ready ()

gboolean
tp_channel_run_until_ready (TpChannel *self,
                            GError **error,
                            GMainLoop **loop);

If self is ready for use (introspection has finished, etc.), return immediately. Otherwise, re-enter the main loop until the channel either becomes invalid or becomes ready for use, or until the main loop stored via loop is cancelled.

[skip]

Since: 0.7.1

TpChannelWhenReadyCb ()

void
(*TpChannelWhenReadyCb) (TpChannel *channel,
                         const GError *error,
                         gpointer user_data);

Signature of a callback passed to tp_channel_call_when_ready(), which will be called exactly once, when the channel becomes ready or invalid (whichever happens first)

tp_channel_call_when_ready ()

void
tp_channel_call_when_ready (TpChannel *self,
                            TpChannelWhenReadyCb callback,
                            gpointer user_data);

If self is ready for use or has been invalidated, call callback immediately, then return. Otherwise, arrange for callback to be called when self either becomes ready for use or becomes invalid.

This is a less general form of tp_proxy_prepare_async(), which should be used in new code. (One important difference is that this function can call callback before it has returned, whereas tp_proxy_prepare_async() always calls callback from the main loop.)

[skip]

Since: 0.7.7

tp_channel_init_known_interfaces ()

void
tp_channel_init_known_interfaces (void);

Ensure that the known interfaces for TpChannel have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument TP_TYPE_CHANNEL.

Since: 0.7.6

tp_channel_is_ready ()

gboolean
tp_channel_is_ready (TpChannel *self);

Returns the same thing as the “channel-ready” property.

New code should use tp_proxy_is_prepared(), which is a more general form of this method.

For group channels, this method is equivalent to checking for the combination of TP_CHANNEL_FEATURE_CORE and TP_CHANNEL_FEATURE_GROUP; for non-group channels, it's equivalent to checking for TP_CHANNEL_FEATURE_CORE.

One important difference is that after “invalidated” is signalled, “channel-ready” keeps its current value - which might be TRUE, if the channel was successfully prepared before it became invalidated - but tp_proxy_is_prepared() returns FALSE for all features.

[skip]

Since: 0.7.12

tp_channel_borrow_connection ()

TpConnection *
tp_channel_borrow_connection (TpChannel *self);

Returns the connection for this channel. The returned pointer is only valid while this channel is valid - reference it with g_object_ref() if needed.

Since: 0.7.12

tp_channel_borrow_immutable_properties ()

GHashTable *
tp_channel_borrow_immutable_properties
                               (TpChannel *self);

Returns the immutable D-Bus properties of this channel, the same as “channel-properties”.

The returned hash table should not be altered, and is not necessarily valid after the main loop is next re-entered. Copy it with g_boxed_copy() (its type is TP_HASH_TYPE_QUALIFIED_PROPERTY_VALUE_MAP) if a copy that remains valid must be kept.

If the “channel-properties” property was not set during construction (e.g. by calling tp_channel_new_from_properties()), a reasonable but possibly incomplete version will be made up from the values of individual properties; reading this property repeatedly may yield progressively more complete values until the TP_CHANNEL_FEATURE_CORE feature is prepared.

tp_channel_get_connection ()

TpConnection *
tp_channel_get_connection (TpChannel *self);

Returns the connection for this channel. The returned pointer is only valid while this channel is valid - reference it with g_object_ref() if needed.

Since: 0.19.9

tp_channel_dup_immutable_properties ()

GVariant *
tp_channel_dup_immutable_properties (TpChannel *self);

Returns the immutable D-Bus properties of this channel, in a variant of type G_VARIANT_TYPE_VARDICT where the keys are strings, D-Bus interface name + "." + property name. Use g_variant_lookup() or g_variant_lookup_value() for convenient access to the values.

If the “channel-properties” property was not set during construction (e.g. by calling tp_channel_new_from_properties()), a reasonable but possibly incomplete version will be made up from the values of individual properties; reading this property repeatedly may yield progressively more complete values until the TP_CHANNEL_FEATURE_CORE feature is prepared.

This function should be used only by TpChannel subclasses, otherwise it is recommended to use individual property getters instead.

Since: 0.19.9

tp_channel_get_channel_type ()

const gchar *
tp_channel_get_channel_type (TpChannel *self);

Get the D-Bus interface name representing this channel's type, if it has been discovered.

This is the same as the “channel-type” property; it isn't guaranteed to be non-NULL until the TP_CHANNEL_FEATURE_CORE feature has been prepared.

Since: 0.7.12

tp_channel_get_channel_type_id ()

GQuark
tp_channel_get_channel_type_id (TpChannel *self);

Get the D-Bus interface name representing this channel's type, as a GQuark, if it has been discovered.

This is the same as the “channel-type” property, except that it is a GQuark rather than a string. It isn't guaranteed to be nonzero until the TP_CHANNEL_FEATURE_CORE property is ready.

Since: 0.7.12

tp_channel_get_handle ()

TpHandle
tp_channel_get_handle (TpChannel *self,
                       TpHandleType *handle_type);

Get the handle representing the contact, chatroom, etc. with which this channel communicates for its whole lifetime, or 0 if there is no such handle or it has not yet been discovered.

This is the same as the “handle” property. It isn't guaranteed to have its final value until the TP_CHANNEL_FEATURE_CORE feature is ready.

If handle_type is not NULL, the type of handle is written into it. This will be TP_UNKNOWN_HANDLE_TYPE if the handle has not yet been discovered, or TP_HANDLE_TYPE_NONE if there is no handle with which this channel will always communicate. This is the same as the “handle-type” property.

Since: 0.7.12

tp_channel_get_identifier ()

const gchar *
tp_channel_get_identifier (TpChannel *self);

This channel's associated identifier, or the empty string if no identifier or unknown.

This is the same as the “identifier” property, and isn't guaranteed to be set until the TP_CHANNEL_FEATURE_CORE property is ready.

Changed in 0.11.4: as with “identifier”, this could previously either be NULL or the empty string if there was no suitable value. It is now non-NULL in all cases.

Since: 0.7.21

tp_channel_get_target_contact ()

TpContact *
tp_channel_get_target_contact (TpChannel *self);

Since: 0.15.6

tp_channel_get_requested ()

gboolean
tp_channel_get_requested (TpChannel *self);

Return the “requested” property

Since: 0.11.15

tp_channel_get_initiator_handle ()

TpHandle
tp_channel_get_initiator_handle (TpChannel *self);

Return the “initiator-handle” property

[skip]

Since: 0.11.15

tp_channel_get_initiator_identifier ()

const gchar *
tp_channel_get_initiator_identifier (TpChannel *self);

Return the “initiator-identifier” property

[skip]

Since: 0.11.15

tp_channel_get_initiator_contact ()

TpContact *
tp_channel_get_initiator_contact (TpChannel *self);

Since: 0.15.6

tp_channel_join_async ()

void
tp_channel_join_async (TpChannel *self,
                       const gchar *message,
                       GAsyncReadyCallback callback,
                       gpointer user_data);

Join channel self with message as join message.

When we joined the channel, callback will be called. You can then call tp_channel_join_finish() to get the result of the operation.

Note that unlike tp_channel_leave_async(), TP_CHANNEL_FEATURE_GROUP feature must be prepared before calling this function.

Since: 0.15.5

tp_channel_join_finish ()

gboolean
tp_channel_join_finish (TpChannel *self,
                        GAsyncResult *result,
                        GError **error);

Completes a call to tp_channel_join_async().

Since: 0.15.5

tp_channel_leave_async ()

void
tp_channel_leave_async (TpChannel *self,
                        TpChannelGroupChangeReason reason,
                        const gchar *message,
                        GAsyncReadyCallback callback,
                        gpointer user_data);

Leave channel self with reason as reason and message as leave message. If self doesn't implement TP_IFACE_QUARK_CHANNEL_INTERFACE_GROUP or if for any reason we can't properly leave the channel, we close it.

When we left the channel, callback will be called. You can then call tp_channel_leave_finish() to get the result of the operation.

Note that unlike tp_channel_join_async(), TP_CHANNEL_FEATURE_GROUP feature does not have to be prepared and will be prepared for you. But this is a deprecated behaviour.

Since: 0.13.10

tp_channel_leave_finish ()

gboolean
tp_channel_leave_finish (TpChannel *self,
                         GAsyncResult *result,
                         GError **error);

Completes a call to tp_channel_leave_async().

Since: 0.13.10

tp_channel_close_async ()

void
tp_channel_close_async (TpChannel *self,
                        GAsyncReadyCallback callback,
                        gpointer user_data);

Close channel self . In most cases, it's generally cleaner to use tp_channel_leave_async() instead to properly leave and close the channel.

When the channel has been closed, callback will be called. You can then call tp_channel_close_finish() to get the result of the operation.

Since: 0.13.10

tp_channel_close_finish ()

gboolean
tp_channel_close_finish (TpChannel *self,
                         GAsyncResult *result,
                         GError **error);

Finishes a call to tp_channel_leave_async().

Since: 0.13.10

tp_channel_destroy_async ()

void
tp_channel_destroy_async (TpChannel *self,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

Destroy channel self . If self doesn't implement TP_IFACE_QUARK_CHANNEL_INTERFACE_DESTROYABLE or if for any reason we can't destroy the channel, we close it.

When the channel has been destroyed or closed, callback will be called. You can then call tp_channel_destroy_finish() to get the result of the operation.

Since: 0.15.2

tp_channel_destroy_finish ()

gboolean
tp_channel_destroy_finish (TpChannel *self,
                           GAsyncResult *result,
                           GError **error);

Completes a call to tp_channel_destroy_async().

Since: 0.15.2

tp_channel_get_chat_state ()

TpChannelChatState
tp_channel_get_chat_state (TpChannel *self,
                           TpHandle contact);

Return the chat state for the given contact. If tp_proxy_is_prepared() would return FALSE for the feature TP_CHANNEL_FEATURE_CHAT_STATES, the result will always be TP_CHANNEL_CHAT_STATE_INACTIVE.

Since: 0.11.3

tp_channel_group_get_flags ()

TpChannelGroupFlags
tp_channel_group_get_flags (TpChannel *self);

Return the “group-flags” property (see the description of that property for notes on validity).

Since: 0.7.12

tp_channel_group_get_handle_owner ()

TpHandle
tp_channel_group_get_handle_owner (TpChannel *self,
                                   TpHandle handle);

Synopsis (see below for further explanation):

Some channels (those with flags that include TP_CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES) have a concept of "channel-specific handles". These are handles that only have meaning within the context of the channel - for instance, in XMPP Multi-User Chat, participants in a chatroom are identified by an in-room JID consisting of the JID of the chatroom plus a local nickname.

Depending on the protocol and configuration, it might be possible to find out what globally valid handle (i.e. an identifier that you could add to your contact list) "owns" a channel-specific handle. For instance, in most XMPP MUC chatrooms, normal users cannot see what global JID corresponds to an in-room JID, but moderators can.

This is further complicated by the fact that channels with channel-specific handles can sometimes have members with globally valid handles (for instance, if you invite someone to an XMPP MUC using their globally valid JID, you would expect to see the handle representing that JID in the Group's remote-pending set).

This function's result is undefined unless the channel is ready and its flags include TP_CHANNEL_GROUP_FLAG_PROPERTIES (an implementation without extra D-Bus round trips is not possible using the older API).

Since: 0.7.12

tp_channel_group_get_contact_owner ()

TpContact *
tp_channel_group_get_contact_owner (TpChannel *self,
                                    TpContact *contact);

Synopsis (see below for further explanation):

Some channels (those with flags that include TP_CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES) have a concept of "channel-specific contacts". These are contacts that only have meaning within the context of the channel - for instance, in XMPP Multi-User Chat, participants in a chatroom are identified by an in-room JID consisting of the JID of the chatroom plus a local nickname.

Depending on the protocol and configuration, it might be possible to find out what globally valid contact (i.e. a contact that you could add to your contact list) "owns" a channel-specific contact. For instance, in most XMPP MUC chatrooms, normal users cannot see what global JID corresponds to an in-room JID, but moderators can.

This is further complicated by the fact that channels with channel-specific contacts can sometimes have members with globally valid contacts (for instance, if you invite someone to an XMPP MUC using their globally valid JID, you would expect to see the contact representing that JID in the Group's remote-pending set).

Since: 0.15.6

tp_channel_group_get_self_handle ()

TpHandle
tp_channel_group_get_self_handle (TpChannel *self);

Return the “group-self-handle” property (see the description of that property for notes on validity).

Since: 0.7.12

tp_channel_group_get_self_contact ()

TpContact *
tp_channel_group_get_self_contact (TpChannel *self);

Since: 0.15.6

tp_channel_group_get_members ()

const TpIntset *
tp_channel_group_get_members (TpChannel *self);

If self is a group and the TP_CHANNEL_FEATURE_GROUP feature has been prepared, return a TpIntset containing its members.

If self is a group but TP_CHANNEL_FEATURE_GROUP has not been prepared, the result may either be a set of members, or NULL.

If self is not a group, return NULL.

Since: 0.7.12

tp_channel_group_dup_members_contacts ()

GPtrArray *
tp_channel_group_dup_members_contacts (TpChannel *self);

If self is a group and the TP_CHANNEL_FEATURE_CONTACTS feature has been prepared, return a GPtrArray containing its members.

If self is a group but TP_CHANNEL_FEATURE_CONTACTS has not been prepared, the result may either be a set of members, or NULL.

If self is not a group, return NULL.

Since: 0.15.6

tp_channel_group_get_local_pending ()

const TpIntset *
tp_channel_group_get_local_pending (TpChannel *self);

If self is a group and the TP_CHANNEL_FEATURE_GROUP feature has been prepared, return a TpIntset containing its local-pending members.

If self is a group but TP_CHANNEL_FEATURE_GROUP has not been prepared, the result may either be a set of local-pending members, or NULL.

If self is not a group, return NULL.

Since: 0.7.12

tp_channel_group_dup_local_pending_contacts ()

GPtrArray *
tp_channel_group_dup_local_pending_contacts
                               (TpChannel *self);

If self is a group and the TP_CHANNEL_FEATURE_CONTACTS feature has been prepared, return a GPtrArray containing its local-pending members.

If self is a group but TP_CHANNEL_FEATURE_CONTACTS has not been prepared, the result may either be a set of local-pending members, or NULL.

If self is not a group, return NULL.

Since: 0.15.6

tp_channel_group_get_remote_pending ()

const TpIntset *
tp_channel_group_get_remote_pending (TpChannel *self);

If self is a group and the TP_CHANNEL_FEATURE_GROUP feature has been prepared, return a TpIntset containing its remote-pending members.

If self is a group but TP_CHANNEL_FEATURE_GROUP has not been prepared, the result may either be a set of remote-pending members, or NULL.

If self is not a group, return NULL.

Since: 0.7.12

tp_channel_group_dup_remote_pending_contacts ()

GPtrArray *
tp_channel_group_dup_remote_pending_contacts
                               (TpChannel *self);

If self is a group and the TP_CHANNEL_FEATURE_CONTACTS feature has been prepared, return a GPtrArray containing its remote-pending members.

If self is a group but TP_CHANNEL_FEATURE_CONTACTS has not been prepared, the result may either be a set of remote-pending members, or NULL.

If self is not a group, return NULL.

Since: 0.15.6

tp_channel_group_get_local_pending_info ()

gboolean
tp_channel_group_get_local_pending_info
                               (TpChannel *self,
                                TpHandle local_pending,
                                TpHandle *actor,
                                TpChannelGroupChangeReason *reason,
                                const gchar **message);

If local_pending is actually the handle of a local-pending contact, write additional information into actor , reason and message and return TRUE. The handle and message are not referenced or copied, and can only be assumed to remain valid until the main loop is re-entered.

If local_pending is not the handle of a local-pending contact, write 0 into actor , TP_CHANNEL_GROUP_CHANGE_REASON_NONE into reason and "" into message , and return FALSE.

Since: 0.7.12

tp_channel_group_get_local_pending_contact_info ()

gboolean
tp_channel_group_get_local_pending_contact_info
                               (TpChannel *self,
                                TpContact *local_pending,
                                TpContact **actor,
                                TpChannelGroupChangeReason *reason,
                                const gchar **message);

If local_pending is actually a local-pending contact, write additional information into actor , reason and message and return TRUE. The contact and message are not referenced or copied, and can only be assumed to remain valid until the main loop is re-entered.

If local_pending is not the handle of a local-pending contact, write NULL into actor , TP_CHANNEL_GROUP_CHANGE_REASON_NONE into reason and "" into message , and return FALSE.

Since: 0.15.6

tp_channel_password_needed ()

gboolean
tp_channel_password_needed (TpChannel *self);

Return the “password-needed” property

Since: 0.15.2

tp_channel_provide_password_async ()

void
tp_channel_provide_password_async (TpChannel *self,
                                   const gchar *password,
                                   GAsyncReadyCallback callback,
                                   gpointer user_data);

Provide password so that self can be joined. This function must be called with the correct password in order for channel joining to proceed if the TpChannel:password-needed property is set.

Once the password has been provided, callback will be called. You can then call tp_channel_provide_password_finish() to get the result of the operation.

Since: 0.15.2

tp_channel_provide_password_finish ()

gboolean
tp_channel_provide_password_finish (TpChannel *self,
                                    GAsyncResult *result,
                                    GError **error);

Completes a call to tp_channel_provide_password_async(). If the password was rejected, the operation fails with TP_ERROR_AUTHENTICATION_FAILED.

Since: 0.15.2

tp_cli_channel_call_close ()

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

Start a Close method call.

Request that the channel be closed. This is not the case until the <tp:member-ref>Closed</tp:member-ref> signal has been emitted, and depending on the connection manager this may simply remove you from the channel on the server, rather than causing it to stop existing entirely. Some channels such as contact list channels may not be closed.

tp_cli_channel_call_get_channel_type ()

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

Start a GetChannelType method call.

Returns the interface name for the type of this channel. Clients SHOULD use the <tp:member-ref>ChannelType</tp:member-ref> property instead, falling back to this method only if necessary. <tp:rationale> The GetAll method lets clients retrieve all properties in one round-trip. </tp:rationale>

tp_cli_channel_call_get_handle ()

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

Start a GetHandle method call.

Returns the handle type and number if this channel represents a communication with a particular contact, room or server-stored list, or zero if it is transient and defined only by its contents. Clients SHOULD use the <tp:member-ref>TargetHandle</tp:member-ref> and <tp:member-ref>TargetHandleType</tp:member-ref> properties instead, falling back to this method only if necessary. <tp:rationale> The GetAll method lets clients retrieve all properties in one round-trip. </tp:rationale>

tp_cli_channel_call_get_interfaces ()

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

Start a GetInterfaces method call.

Get the optional interfaces implemented by the channel. Clients SHOULD use the <tp:member-ref>Interfaces</tp:member-ref> property instead, falling back to this method only if necessary. <tp:rationale> The GetAll method lets clients retrieve all properties in one round-trip. </tp:rationale>

tp_cli_channel_callback_for_close ()

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

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

tp_cli_channel_callback_for_get_channel_type ()

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

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

tp_cli_channel_callback_for_get_handle ()

void
(*tp_cli_channel_callback_for_get_handle)
                               (TpChannel *proxy,
                                guint out_Target_Handle_Type,
                                guint out_Target_Handle,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

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

tp_cli_channel_callback_for_get_interfaces ()

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

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

tp_cli_channel_run_close ()

gboolean
tp_cli_channel_run_close (TpChannel *proxy,
                          gint timeout_ms,
                          GError **error,
                          GMainLoop **loop);

Call the method Close and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.

Request that the channel be closed. This is not the case until the <tp:member-ref>Closed</tp:member-ref> signal has been emitted, and depending on the connection manager this may simply remove you from the channel on the server, rather than causing it to stop existing entirely. Some channels such as contact list channels may not be closed.

tp_cli_channel_run_get_channel_type ()

gboolean
tp_cli_channel_run_get_channel_type (TpChannel *proxy,
                                     gint timeout_ms,
                                     gchar **out_Channel_Type,
                                     GError **error,
                                     GMainLoop **loop);

Call the method GetChannelType and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.

Returns the interface name for the type of this channel. Clients SHOULD use the <tp:member-ref>ChannelType</tp:member-ref> property instead, falling back to this method only if necessary. <tp:rationale> The GetAll method lets clients retrieve all properties in one round-trip. </tp:rationale>

tp_cli_channel_run_get_handle ()

gboolean
tp_cli_channel_run_get_handle (TpChannel *proxy,
                               gint timeout_ms,
                               guint *out_Target_Handle_Type,
                               guint *out_Target_Handle,
                               GError **error,
                               GMainLoop **loop);

Call the method GetHandle and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.

Returns the handle type and number if this channel represents a communication with a particular contact, room or server-stored list, or zero if it is transient and defined only by its contents. Clients SHOULD use the <tp:member-ref>TargetHandle</tp:member-ref> and <tp:member-ref>TargetHandleType</tp:member-ref> properties instead, falling back to this method only if necessary. <tp:rationale> The GetAll method lets clients retrieve all properties in one round-trip. </tp:rationale>

tp_cli_channel_run_get_interfaces ()

gboolean
tp_cli_channel_run_get_interfaces (TpChannel *proxy,
                                   gint timeout_ms,
                                   gchar ***out_Interfaces,
                                   GError **error,
                                   GMainLoop **loop);

Call the method GetInterfaces and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.

Get the optional interfaces implemented by the channel. Clients SHOULD use the <tp:member-ref>Interfaces</tp:member-ref> property instead, falling back to this method only if necessary. <tp:rationale> The GetAll method lets clients retrieve all properties in one round-trip. </tp:rationale>

tp_cli_channel_connect_to_closed ()

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

Connect a handler to the signal Closed.

Emitted when the channel has been closed. Method calls on the channel are no longer valid after this signal has been emitted, and the connection manager may then remove the object from the bus at any point.

tp_cli_channel_signal_callback_closed ()

void
(*tp_cli_channel_signal_callback_closed)
                               (TpChannel *proxy,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal Closed.

tp_cli_channel_interface_destroyable_call_destroy ()

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

Start a Destroy method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Close the channel abruptly, possibly with loss of data. The connection manager MUST NOT re-create the channel unless/until more events occur.</p> <tp:rationale> <p>The main motivating situation for this method is that when a Text channel with pending messages is closed with Close, it comes back as an incoming channel (to avoid a race between Close and an incoming message). If Destroy is called on a Text channel, the CM should delete all pending messages and close the channel, and the channel shouldn't be re-created until/unless another message arrives.</p> </tp:rationale> <p>Most clients SHOULD call <tp:dbus-ref namespace="org.freedesktop.Telepathy">Channel.Close</tp:dbus-ref> instead. However, if a client explicitly intends to destroy the channel with possible loss of data, it SHOULD call this method if this interface is supported (according to the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Channel.Interfaces</tp:dbus-ref> property), falling back to Close if not.</p> <p>In particular, channel dispatchers SHOULD use this method if available when terminating channels that cannot be handled correctly (for instance, if no handler has been installed for a channel type, or if the handler crashes repeatedly).</p> <p>Connection managers do not need to implement this interface on channels where Close and Destroy would be equivalent.</p> <tp:rationale> <p>Callers need to be able to fall back to Close in any case.</p> </tp:rationale>

tp_cli_channel_interface_destroyable_callback_for_destroy ()

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

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

tp_cli_channel_interface_destroyable_run_destroy ()

gboolean
tp_cli_channel_interface_destroyable_run_destroy
                               (TpChannel *proxy,
                                gint timeout_ms,
                                GError **error,
                                GMainLoop **loop);

Call the method Destroy and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Close the channel abruptly, possibly with loss of data. The connection manager MUST NOT re-create the channel unless/until more events occur.</p> <tp:rationale> <p>The main motivating situation for this method is that when a Text channel with pending messages is closed with Close, it comes back as an incoming channel (to avoid a race between Close and an incoming message). If Destroy is called on a Text channel, the CM should delete all pending messages and close the channel, and the channel shouldn't be re-created until/unless another message arrives.</p> </tp:rationale> <p>Most clients SHOULD call <tp:dbus-ref namespace="org.freedesktop.Telepathy">Channel.Close</tp:dbus-ref> instead. However, if a client explicitly intends to destroy the channel with possible loss of data, it SHOULD call this method if this interface is supported (according to the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Channel.Interfaces</tp:dbus-ref> property), falling back to Close if not.</p> <p>In particular, channel dispatchers SHOULD use this method if available when terminating channels that cannot be handled correctly (for instance, if no handler has been installed for a channel type, or if the handler crashes repeatedly).</p> <p>Connection managers do not need to implement this interface on channels where Close and Destroy would be equivalent.</p> <tp:rationale> <p>Callers need to be able to fall back to Close in any case.</p> </tp:rationale>

struct TpChannel

struct TpChannel;

A proxy object for a Telepathy channel. A proxy object for a Telepathy channel. There are no interesting public struct fields.

(Changed in 0.7.12: the layout of the structure is visible, allowing subclassing.)

Since: 0.7.1

struct TpChannelClass

struct TpChannelClass {
    TpProxyClass parent_class;
};

The class of a TpChannel. In addition to parent_class there are four pointers reserved for possible future use.

(Changed in 0.7.12: the layout of the structure is visible, allowing subclassing.)

Since: 0.7.1

TP_CHANNEL_FEATURE_CORE

#define             TP_CHANNEL_FEATURE_CORE

Expands to a call to a function that returns a quark for the "core" feature on a TpChannel.

When this feature is prepared, the basic Channel properties of the Channel have been retrieved and are available for use.

Specifically, this implies that:

(These are a subset of the guarantees offered by the older “channel-ready” and tp_channel_call_when_ready() mechanisms, which are now equivalent to (TP_CHANNEL_FEATURE_CORE, TP_CHANNEL_FEATURE_GROUP) if the channel is a group, or just TP_CHANNEL_FEATURE_CORE otherwise.)

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since: 0.11.3

TP_CHANNEL_FEATURE_CONTACTS

#define             TP_CHANNEL_FEATURE_CONTACTS

Expands to a call to a function that returns a quark representing the Contacts features of a TpChannel.

When this feature is prepared, the TpContact objects of this channel are guaranteed to have all of the features previously passed to tp_simple_client_factory_add_contact_features() prepared.

On older connection managers, this feature may fail to prepare.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since: 0.15.6

TP_CHANNEL_FEATURE_CHAT_STATES

#define             TP_CHANNEL_FEATURE_CHAT_STATES

Expands to a call to a function that returns a quark representing the chat states feature on a TpChannel.

When this feature is prepared, tp_channel_get_chat_state() and the “chat-state-changed” signal become useful.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since: 0.11.3

TP_CHANNEL_FEATURE_GROUP

#define             TP_CHANNEL_FEATURE_GROUP

Expands to a call to a function that returns a quark representing the Group features of a TpChannel.

When this feature is prepared, the Group properties of the Channel have been retrieved and are available for use, and change-notification has been set up for those that can change:

(These are the same guarantees offered for Group channels by the older “channel-ready” and tp_channel_call_when_ready() mechanisms.)

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since: 0.11.3

TP_ERRORS_REMOVED_FROM_GROUP

#define TP_ERRORS_REMOVED_FROM_GROUP (tp_errors_removed_from_group_quark ())

GError domain representing the local user being removed from a channel with the Group interface. The code in a GError with this domain must be a member of TpChannelGroupChangeReason.

This error may be raised on non-Group channels with certain reason codes if there's no better error code to use (mainly TP_CHANNEL_GROUP_CHANGE_REASON_NONE).

This macro expands to a function call returning a GQuark.

Since: 0.7.1

TP_CHANNEL_FEATURE_PASSWORD

#define             TP_CHANNEL_FEATURE_PASSWORD

Expands to a call to a function that returns a quark representing the password feature on a TpChannel.

When this feature is prepared, tp_channel_password_needed() and the “password-needed” property become useful.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since: 0.15.2

The “channel-properties” property

  “channel-properties”       GHashTable_gchararray+GValue_*

The immutable D-Bus properties of this channel, represented by a GHashTable where the keys are D-Bus interface name + "." + property name, and the values are GValue instances.

Read-only except during construction. If this is not provided during construction, a reasonable (but possibly incomplete) version will be made up from the values of individual properties; reading this property repeatedly may yield progressively more complete values until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CORE.

Owner: TpChannel

Flags: Read / Write / Construct Only

The “channel-ready” property

  “channel-ready”            gboolean

Initially FALSE; changes to TRUE when tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CORE, and if the channel is a group, TP_CHANNEL_FEATURE_GROUP.

This is a less general form of tp_proxy_is_prepared(), which should be used in new code.

One important difference is that after “invalidated” is signalled, “channel-ready” keeps its current value - which might be TRUE, if the channel was successfully prepared before it became invalidated - but tp_proxy_is_prepared() returns FALSE for all features.

Change notification is via notify::channel-ready.

Owner: TpChannel

Flags: Read

Default value: FALSE

The “connection” property

  “connection”               TpConnection *

The TpConnection to which this TpChannel belongs. Used for e.g. handle manipulation.

Owner: TpChannel

Flags: Read / Write / Construct Only

The “group-flags” property

  “group-flags”              guint

If the TP_CHANNEL_FEATURE_GROUP feature has been prepared successfully, TpChannelGroupFlags indicating the capabilities and behaviour of that group.

Otherwise, this may be 0.

Change notification is via notify::group-flags or TpChannel::group-flags-changed.

Owner: TpChannel

Flags: Read

Default value: 0

Since: 0.7.12

The “group-self-contact” property

  “group-self-contact”       TpContact *

If this channel is a group and TP_CHANNEL_FEATURE_CONTACTS has been prepared, and the user is a member of the group, the TpContact representing them in this group.

Otherwise, the result may be either a contact representing the user, or NULL.

Change notification is via notify::group-self-contact.

Owner: TpChannel

Flags: Read

Since: 0.15.6

The “group-self-handle” property

  “group-self-handle”        guint

If this channel is a group and TP_CHANNEL_FEATURE_GROUP has been prepared, and the user is a member of the group, the TpHandle representing them in this group.

Otherwise, the result may be either a handle representing the user, or 0.

Change notification is via notify::group-self-handle.

Owner: TpChannel

Flags: Read

Default value: 0

Since: 0.7.12

The “identifier” property

  “identifier”               gchar *

This channel's associated identifier, or the empty string if it has handle type TP_HANDLE_TYPE_NONE.

For channels where “handle” is non-zero, this is the result of inspecting “handle”.

This is not guaranteed to be set until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CORE; until then, it may be the empty string.

Changed in 0.11.4: this property is never NULL. Previously, it was NULL before an identifier was known, or when a channel with no TargetID D-Bus property had TargetHandleType TP_HANDLE_TYPE_NONE.

Owner: TpChannel

Flags: Read

Default value: ""

The “initiator-contact” property

  “initiator-contact”        TpContact *

The TpContact of the initiator of this channel, or NULL if there is no particular initiator.

If the channel was initiated by a remote contact, this represents that contact, and “requested” will be FALSE. For instance, for an incoming call this property indicates the caller, and for a chatroom invitation this property indicates who sent the invitation.

If the channel was requested by the local user, “requested” will be TRUE, and this property may be the “group-self-contact” or “self-contact”.

If the channel appeared for some other reason (for instance as a side-effect of connecting to the server), this property may be NULL.

This is not guaranteed to be set until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CONTACTS; until then, it may be NULL.

Owner: TpChannel

Flags: Read

Since: 0.15.6

The “initiator-handle” property

  “initiator-handle”         guint

The TP_HANDLE_TYPE_CONTACT TpHandle of the initiator of this channel, or 0 if there is no particular initiator.

If the channel was initiated by a remote contact, this handle represents that contact, and “requested” will be FALSE. For instance, for an incoming call this property indicates the caller, and for a chatroom invitation this property indicates who sent the invitation.

If the channel was requested by the local user, “requested” will be TRUE, and this property may be the “group-self-handle” or “self-handle”.

If the channel appeared for some other reason (for instance as a side-effect of connecting to the server), this property may be 0.

This is not guaranteed to be set until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CORE; until then, it may be 0.

Owner: TpChannel

Flags: Read

Default value: 0

Since: 0.11.15

The “initiator-identifier” property

  “initiator-identifier”     gchar *

If “initiator-handle” is 0, this will always be "". Otherwise, this will be the “identifier” of the contact with that handle.

This is not guaranteed to be set until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CORE; until then, it may be the empty string.

Owner: TpChannel

Flags: Read

Default value: ""

Since: 0.11.15

The “password-needed” property

  “password-needed”          gboolean

If TRUE, tp_channel_provide_password_async() has to be called to be able to join the channel.

This is not guaranteed to be meaningful until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_PASSWORD; until then, it may return FALSE even if the channel is actually protected by a password. Preparing TP_CHANNEL_FEATURE_PASSWORD also ensures that the notify::password-needed signal will be fired when this property changes.

Owner: TpChannel

Flags: Read

Default value: FALSE

Since: 0.15.2

The “requested” property

  “requested”                gboolean

TRUE if this channel was created in response to a local request, such as a call to tp_account_channel_request_create_channel_async(). FALSE if this channel was initiated by a remote contact (the “initiator-handle”), or if it appeared as a side-effect of some other action.

For instance, this is FALSE on incoming calls and file transfers, remotely-initiated 1-1 text conversations, and invitations to chatrooms, and TRUE on outgoing calls and file transfers, locally-initiated 1-1 text conversations, and chatrooms joined by local user action.

This is not guaranteed to be meaningful until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CORE; until then, it may return FALSE even if the channel was actually requested.

Owner: TpChannel

Flags: Read

Default value: FALSE

Since: 0.11.15

The “target-contact” property

  “target-contact”           TpContact *

If this channel is for communication with a single contact (that is, “handle-type” is TP_HANDLE_TYPE_CONTACT), then a TpContact representing the remote contact. For chat rooms, contact search channels and other channels without a single remote contact, NULL.

This is not guaranteed to be set until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CONTACTS; until then, it may be NULL.

Owner: TpChannel

Flags: Read

Since: 0.15.6

The “chat-state-changed” signal

void
user_function (TpChannel *self,
               guint      contact,
               guint      state,
               gpointer   user_data)

Emitted when a contact's chat state changes after tp_proxy_prepare_async() has finished preparing the feature TP_CHANNEL_FEATURE_CHAT_STATES.

Flags: Has Details

Since: 0.11.3

The “group-contacts-changed” signal

void
user_function (TpChannel *self,
               GPtrArray *added,
               GPtrArray *removed,
               GPtrArray *local_pending,
               GPtrArray *remote_pending,
               TpContact *actor,
               gpointer   user_data)

Emitted when the group members change in a Group channel.

This is not guaranteed to be emitted until tp_proxy_prepare_async() has finished preparing TP_CHANNEL_FEATURE_CONTACTS; until then, it may be omitted.

Flags: Has Details

Since: 0.15.6

The “group-flags-changed” signal

void
user_function (TpChannel *self,
               guint      added,
               guint      removed,
               gpointer   user_data)

Emitted when the “group-flags” property changes while the channel is ready.

Flags: Has Details

Since: 0.7.12

The “group-members-changed” signal

void
user_function (TpChannel     *self,
               gchar         *message,
               GArray_guint_ *added,
               GArray_guint_ *removed,
               GArray_guint_ *local_pending,
               GArray_guint_ *remote_pending,
               guint          actor,
               guint          reason,
               gpointer       user_data)

Emitted when the group members change in a Group channel that is ready.

[skip]

Flags: Has Details

Since: 0.7.12

The “group-members-changed-detailed” signal

void
user_function (TpChannel     *self,
               GArray_guint_ *added,
               GArray_guint_ *removed,
               GArray_guint_ *local_pending,
               GArray_guint_ *remote_pending,
               gpointer       user_data)

Emitted when the group members change in a Group channel that is ready. Contains a superset of the information in the TpChannel::group-members-changed signal, and is emitted at the same time; applications can connect to this signal and ignore the other.

Flags: Has Details

Since: 0.7.21