The contact's alias if available, falling back to their #TpContact:identifier if no alias is available or if the #TpContact has not been set up to track %TP_CONTACT_FEATURE_ALIAS.
This alias may have been supplied by the contact themselves, or by the local user, so it does not necessarily unambiguously identify the contact. However, it is suitable for use as a main "display name" for the contact.
This is never %NULL for contact objects that are visible to library-user code.
#GFile to the latest cached avatar image, or %NULL if this contact has no avatar, or if the avatar data is not yet retrieved.
When #TpContact:avatar-token changes, this property is not updated immediately, but will be updated when the new avatar data is retrieved and stored in cache. Until then, the file will keep its old value of the latest cached avatar image.
This is set to %NULL if %TP_CONTACT_FEATURE_AVATAR_DATA is not set on this contact. Note that setting %TP_CONTACT_FEATURE_AVATAR_DATA will also implicitly set %TP_CONTACT_FEATURE_AVATAR_TOKEN.
MIME type of the latest cached avatar image, or %NULL if this contact has no avatar, or if the avatar data is not yet retrieved.
This is always the MIME type of the image given by #TpContact:avatar-file.
An opaque string representing state of the contact's avatar (depending on the protocol, this might be a hash, a timestamp or something else), or an empty string if there is no avatar.
This may be %NULL if it is not known whether this contact has an avatar or not (either for network protocol reasons, or because this #TpContact has not been set up to track %TP_CONTACT_FEATURE_AVATAR_TOKEN).
The capabilities supported by this contact. If the underlying Connection doesn't support the ContactCapabilities interface, this property will contain the capabilities supported by the connection. Use tp_capabilities_is_specific_to_contact() to check if the capabilities are specific to this #TpContact or not.
This may be %NULL if this #TpContact object has not been set up to track %TP_CONTACT_FEATURE_CAPABILITIES.
A #GStrv containing the client types of this contact.
This is set to %NULL if %TP_CONTACT_FEATURE_CLIENT_TYPES is not set on this contact; it may also be %NULL if that feature is prepared, but the contact's client types are unknown.
The #TpConnection to which this contact belongs.
a #GStrv with names of groups of which a contact is a member.
This is set to %NULL if %TP_CONTACT_FEATURE_CONTACT_GROUPS is not prepared on this contact, or if the connection does not implement ContactGroups interface.
A #GList of #TpContactInfoField representing the vCard of this contact.
This is set to %NULL if %TP_CONTACT_FEATURE_CONTACT_INFO is not set on this contact.
The contact's handle in the Telepathy D-Bus API, a handle of type %TP_HANDLE_TYPE_CONTACT representing the string given by #TpContact:identifier.
This handle is referenced using the Telepathy D-Bus API and remains referenced for as long as the #TpContact exists and the #TpContact:connection remains valid.
However, getting this property does not cause an additional reference to the handle to be held.
If the #TpContact:connection becomes invalid, this property is no longer meaningful and will be set to 0.
The contact's identifier in the instant messaging protocol (e.g. XMPP JID, SIP URI, AOL screenname or IRC nick - whatever the underlying protocol uses to identify a user).
This is never %NULL for contact objects that are visible to library-user code.
%TRUE if the contact has been blocked.
This is set to %FALSE if %TP_CONTACT_FEATURE_CONTACT_BLOCKING is not prepared on this contact, or if the connection does not implement ContactBlocking interface.
If this contact has set a user-defined location, a string to variant map containing his location. If not, %NULL. tp_vardict_get_string() and similar functions can be used to access the contents.
This may be %NULL even if the contact has set a location, if this #TpContact object has not been set up to track %TP_CONTACT_FEATURE_LOCATION.
This property contains the same information as #TpContact:location, in a different format.
If this contact has set a user-defined status message, that message; if not, an empty string (which user interfaces may replace with a localized form of the #TpContact:presence-status or #TpContact:presence-type).
This may be an empty string even if the contact has set a message, if this #TpContact object has not been set up to track %TP_CONTACT_FEATURE_PRESENCE. It is never %NULL.
A string representing the presence status of this contact. This may be a well-known string from the Telepathy specification, like "available", or a connection-manager-specific string, like "out-to-lunch".
This may be an empty string if this #TpContact object has not been set up to track %TP_CONTACT_FEATURE_PRESENCE. It is never %NULL.
The #TpConnectionPresenceType representing the type of presence status for this contact.
This is provided so even unknown values for #TpContact:presence-status can be classified into their fundamental types.
This may be %TP_CONNECTION_PRESENCE_TYPE_UNSET if this #TpContact has not been set up to track %TP_CONTACT_FEATURE_PRESENCE.
The message that contact sent when they requested permission to see the local user's presence, if #TpContact:publish-state is %TP_SUBSCRIPTION_STATE_ASK, an empty string ("") otherwise.
This is set to %NULL until %TP_CONTACT_FEATURE_SUBSCRIPTION_STATES has been prepared, and it is guaranteed to be non-%NULL afterward.
A #TpSubscriptionState indicating the state of this contact's subscription to the local user's presence.
This is set to %TP_SUBSCRIPTION_STATE_UNKNOWN until %TP_CONTACT_FEATURE_SUBSCRIPTION_STATES has been prepared
A #TpSubscriptionState indicating the state of the local user's subscription to this contact's presence.
This is set to %TP_SUBSCRIPTION_STATE_UNKNOWN until %TP_CONTACT_FEATURE_SUBSCRIPTION_STATES has been prepared
Convenience wrapper for tp_connection_add_to_group_async() on a single contact.
the group to alter.
a callback to call when the operation finishes
Finishes tp_contact_add_to_group_async()
a #GAsyncResult
Convenience wrapper for tp_connection_authorize_publication_async() on a single contact.
a callback to call when the operation finishes
Finishes tp_contact_authorize_publication_async()
a #GAsyncResult
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Block communications with a contact, optionally reporting the contact as abusive to the server administrators. To block more than one contact at once, see tp_connection_block_contacts_async().
If %TRUE, report this contact as abusive to the server administrators as well as blocking him. See #TpConnection:can-report-abusive to discover whether reporting abuse is supported. If #TpConnection:can-report-abusive is %FALSE, this parameter will be ignored.
a callback to call when the operation finishes
Finishes tp_contact_block_async()
a #GAsyncResult
Returns a newly allocated #GList of contact's vCard fields. The list must be freed with tp_contact_info_list_free() after used.
Same as the #TpContact:contact-info property.
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Return the #TpAccount of self's #TpContact:connection.
See tp_connection_get_account() for details.
Return the contact's alias. This remains valid until the main loop is re-entered; if the caller requires a string that will persist for longer than that, it must be copied with g_strdup().
Return the contact's avatar MIME type. This remains valid until the main loop is re-entered; if the caller requires a string that will persist for longer than that, it must be copied with g_strdup().
Return the contact's avatar token. This remains valid until the main loop is re-entered; if the caller requires a string that will persist for longer than that, it must be copied with g_strdup().
Return the contact's client types or %NULL if the client types are unspecified.
Return names of groups of which a contact is a member. It is incorrect to call this method before %TP_CONTACT_FEATURE_CONTACT_GROUPS has been prepared. This remains valid until the main loop is re-entered; if the caller requires a #GStrv that will persist for longer than that, it must be copied with g_strdupv().
Returns a newly allocated #GList of contact's vCard fields. The list must be freed with g_list_free() after used.
Note that the #TpContactInfoFields in the returned #GList are not dupped before returning from this function. One could copy every item in the list using tp_contact_info_field_copy().
Same as the #TpContact:contact-info property.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Return the contact's handle, which is of type %TP_HANDLE_TYPE_CONTACT, or 0 if the #TpContact:connection has become invalid.
This handle is referenced using the Telepathy D-Bus API and remains
referenced for as long as self exists and the
#TpContact:connection remains valid.
However, the caller of this function does not gain an additional reference to the handle.
Return the contact's identifier. This remains valid for as long as self
exists; if the caller requires a string that will persist for longer than
that, it must be copied with g_strdup().
Return the contact's user-defined location or %NULL if the location is unspecified. This remains valid until the main loop is re-entered; if the caller requires a hash table that will persist for longer than that, it must be reffed with g_hash_table_ref().
Return the contact's user-defined status message, or an empty string. This remains valid until the main loop is re-entered; if the caller requires a string that will persist for longer than that, it must be copied with g_strdup().
Return the name of the contact's presence status, or an empty string. This remains valid until the main loop is re-entered; if the caller requires a string that will persist for longer than that, it must be copied with g_strdup().
If this object has been set up to track %TP_CONTACT_FEATURE_PRESENCE and the underlying connection supports either the Presence or SimplePresence interfaces, return the type of the contact's presence.
Otherwise, return %TP_CONNECTION_PRESENCE_TYPE_UNSET.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
If #TpContact:publish-state is set to %TP_SUBSCRIPTION_STATE_ASK, return the message that this remote contact sent when they requested permission to see the local user's presence, an empty string ("") otherwise. This remains valid until the main loop is re-entered; if the caller requires a string that will persist for longer than that, it must be copied with g_strdup().
This is set to %NULL until %TP_CONTACT_FEATURE_SUBSCRIPTION_STATES has been prepared, and it is guaranteed to be non-%NULL afterward.
Return the state of this remote contact's subscription to the local user's presence.
This is set to %TP_SUBSCRIPTION_STATE_UNKNOWN until %TP_CONTACT_FEATURE_SUBSCRIPTION_STATES has been prepared
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Return the state of the local user's subscription to this remote contact's presence.
This is set to %TP_SUBSCRIPTION_STATE_UNKNOWN until %TP_CONTACT_FEATURE_SUBSCRIPTION_STATES has been prepared
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
a desired feature
Checks whether object has a [floating][floating-ref] reference.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Convenience wrapper for tp_connection_remove_contacts_async() on a single contact.
a callback to call when the operation finishes
Finishes tp_contact_remove_async()
a #GAsyncResult
Convenience wrapper for tp_connection_remove_from_group_async() on a single contact.
the group to alter.
a callback to call when the operation finishes
Finishes tp_contact_remove_from_group_async()
a #GAsyncResult
Requests an asynchronous request of the contact info of self. When
the operation is finished, callback will be called. You can then call
tp_contact_request_contact_info_finish() to get the result of the operation.
If the operation is successful, the #TpContact:contact-info property will be
updated (emitting "notify::contact-info" signal) before callback is called.
That means you can call tp_contact_get_contact_info() to get the new vCard
inside callback.
Note that requesting the vCard from the network can take significant time, so
a bigger timeout is set on the underlying D-Bus call. cancellable can be
cancelled to free resources used in the D-Bus call if the caller is no longer
interested in the vCard.
If %TP_CONTACT_FEATURE_CONTACT_INFO is not yet set on self, it will be
set before its property gets updated and callback is called.
optional #GCancellable object, %NULL to ignore.
a callback to call when the request is satisfied
Finishes an async request of self info. If the operation was successful,
the contact's vCard can be accessed using tp_contact_get_contact_info().
a #GAsyncResult
Convenience wrapper for tp_connection_request_subscription_async() on a single contact.
an optional message
a callback to call when the operation finishes
Finishes tp_contact_request_subscription_async()
a #GAsyncResult
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Add self to the given groups (creating new groups if necessary), and remove
it from all other groups. If the user is removed from a group of which they
were the only member, the group MAY be removed automatically. You can then
call tp_contact_set_contact_groups_finish() to get the result of the
operation.
If the operation is successful and %TP_CONTACT_FEATURE_CONTACT_GROUPS is
prepared, the #TpContact:contact-groups property will be
updated (emitting "notify::contact-groups" signal) and
#TpContact::contact-groups-changed signal will be emitted before callback
is called. That means you can call tp_contact_get_contact_groups() to get the
new contact groups inside callback.
the set of groups which the contact should be in (may be %NULL if n_groups is 0)
a callback to call when the request is satisfied
Finishes an async set of self contact groups.
a #GAsyncResult
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets a property on an object.
the name of the property to set
the value
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblock communications with a contact. To unblock more than one contact at once, see tp_connection_unblock_contacts_async().
a callback to call when the operation finishes
Finishes tp_contact_unblock_async()
a #GAsyncResult
Convenience wrapper for tp_connection_unpublish_async() on a single contact.
a callback to call when the operation finishes
Finishes tp_contact_unpublish_async()
a #GAsyncResult
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Convenience wrapper for tp_connection_unsubscribe_async() on a single contact.
a callback to call when the operation finishes
Finishes tp_contact_unsubscribe_async()
a #GAsyncResult
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
An object representing a contact on a #TpConnection.
Contact objects support tracking a number of attributes of contacts, as described by the #TpContactFeature flags. Features can be specified when instantiating contact objects (with tp_connection_get_contacts_by_id() or tp_connection_get_contacts_by_handle()), or added to an existing contact object with tp_connection_upgrade_contacts(). For example, a client wishing to keep track of a contact's alias would set #TP_CONTACT_FEATURE_ALIAS, and then listen for the "notify::alias" signal, emitted whenever the #TpContact:alias property changes.
Note that releasing a #TpContact object might release handle references held by calling tp_cli_connection_call_request_handles(), tp_cli_connection_run_request_handles(), tp_cli_connection_call_hold_handles(), tp_cli_connection_run_hold_handles(), tp_cli_connection_interface_contacts_call_get_contact_attributes() or tp_cli_connection_interface_contacts_run_get_contact_attributes() directly. Those functions should be avoided in favour of using #TpContact, tp_connection_hold_handles(), tp_connection_request_handles() and tp_connection_get_contact_attributes().