Convenient function to create a new #TpSimpleHandler instance.
If dbus is not the result of tp_dbus_daemon_dup(), you should call
tp_simple_handler_new_with_am() instead, so that #TpAccount,
#TpConnection and #TpContact instances can be shared between modules.
a #TpDBusDaemon object, may not be %NULL
the value of the Handler.BypassApproval D-Bus property (see tp_base_client_set_handler_bypass_approval() for details)
whether this handler should implement Requests (see tp_base_client_set_handler_request_notification() for details)
the name of the Handler (see #TpBaseClient:name for details)
the value of the #TpBaseClient:uniquify-name property
the function called when HandleChannels is called
Account manager for this base client, used to look up or create #TpAccount objects. This may be specified in the constructor in order to get existing #TpAccount objects.
It is not guaranteed that any of its features have been prepared, and it is not necessary to wait for any features before specifying this property in the constructor.
Clients that interact with the #TpAccount should usually set this property instead of #TpBaseClient:dbus-daemon. Doing this will ensure that each account, connection or contact is represented by a single #TpAccount, #TpConnection or #TpContact object, shared between all the cooperating modules that have the same #TpAccountManager.
If the #TpBaseClient:dbus-daemon is set to the result of tp_dbus_daemon_dup(), then this property defaults to the result of tp_account_manager_dup().
This property may be %NULL initially, but will always be non-%NULL after the #TpBaseClient has been constructed.
It is an error to specify both a non-%NULL account manager, and a non-%NULL #TpBaseClient:dbus-daemon that is not the same as the account manager's #TpProxy:dbus-daemon.
The value of the Handler.BypassApproval D-Bus property.
The #TpSimpleHandlerHandleChannelsImpl callback implementing the HandleChannels D-Bus method.
This property can't be %NULL.
The object implementing the #TpClientChannelFactoryInterface interface that will be used to create channel proxies. While tp_base_client_register() has not yet been called, this property can be changed using tp_base_client_set_channel_factory().
If no channel factory is specified then #TpAutomaticProxyFactory is used.
#TpDBusDaemon object encapsulating this object's connection to D-Bus. Read-only except during construction.
This property can't be %NULL after construction.
Since 0.11.14 this property may be %NULL or unspecified in g_object_new(), but only if #TpBaseClient:account-manager is provided instead, in which case its #TpProxy:dbus-daemon property will be used.
The #GDestroyNotify function called to free #TpSimpleHandler:user-data when the #TpSimpleHandler is destroyed.
Factory for this base client, used to look up or create #TpAccount objects.
The name of the client. This is used to register the D-Bus service name and object path of the service.
This property can't be %NULL.
If %TRUE, the Handler will implement the Requests interface
If %TRUE, tp_base_client_register() will append an unique token to the service bus name and object path to ensure they are unique.
The user-data pointer passed to #TpSimpleHandler:callback.
Request that the given features are prepared on each #TpAccount (in addition to %TP_ACCOUNT_FEATURE_CORE) before calling #TpBaseClientClass.observe_channels, #TpBaseClientClass.add_dispatch_operation or #TpBaseClientClass.handle_channels, or emitting #TpBaseClient::request-added.
the features
Register a new channel class as Approver.ApproverChannelFilter.
The #TpBaseClientClass.add_dispatch_operation virtual method will be called
whenever a new channel's properties match the ones in filter.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.add_dispatch_operation.
a %TP_HASH_TYPE_CHANNEL_CLASS
Register a new channel class as Approver.ApproverChannelFilter.
The #TpBaseClientClass.add_dispatch_operation virtual method will be called
whenever a new channel's properties match the ones in filter.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.add_dispatch_operation.
If the variant is floating (see g_variant_ref_sink()), ownership will be taken. See tp_base_client_add_observer_filter_vardict() for more details.
Request that the given features are prepared on each #TpChannel (in addition to %TP_CHANNEL_FEATURE_CORE) before calling #TpBaseClientClass.observe_channels, #TpBaseClientClass.add_dispatch_operation or #TpBaseClientClass.handle_channels.
the features
Request that the given features are prepared on each #TpConnection (in addition to %TP_CONNECTION_FEATURE_CORE) before calling #TpBaseClientClass.observe_channels, #TpBaseClientClass.add_dispatch_operation or #TpBaseClientClass.handle_channels.
the features
Add several capability tokens to this client. These are used to signal that Telepathy connection managers should advertise certain capabilities to other contacts, such as the ability to receive audio/video calls using particular streaming protocols and codecs.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
capability tokens as defined by the Telepathy D-Bus API Specification
Add one capability token to this client, as if via tp_base_client_add_handler_capabilities().
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
a capability token as defined by the Telepathy D-Bus API Specification
Register a new channel class as Handler.HandlerChannelFilter.
The #TpBaseClientClass.handle_channels virtual method will be called
whenever a new channel's properties match the ones in filter.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
a %TP_HASH_TYPE_CHANNEL_CLASS
Register a new channel class as Handler.HandlerChannelFilter.
The #TpBaseClientClass.handle_channels virtual method will be called
whenever a new channel's properties match the ones in filter.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
If the variant is floating (see g_variant_ref_sink()), ownership will be taken. See tp_base_client_add_observer_filter_vardict() for more details.
Register a new channel class as Observer.ObserverChannelFilter.
The #TpBaseClientClass.observe_channels virtual method will be called
whenever a new channel's properties match the ones in filter.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.observe_channels.
a %TP_HASH_TYPE_CHANNEL_CLASS
Register a new channel class as Observer.ObserverChannelFilter.
The #TpBaseClientClass.observe_channels virtual method will be called
whenever a new channel's properties match the ones in filter.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.observe_channels.
If the variant is floating (see g_variant_ref_sink()), ownership will be taken, allowing for uses like this:
|[ tp_base_client_add_observer_filter_vardict (client, g_variant_new_parsed ("{ %s: <%s>, %s: <%u>, ... }", TP_PROP_CHANNEL_CHANNEL_TYPE, TP_IFACE_CHANNEL_TYPE_TEXT, TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, (guint32) TP_HANDLE_TYPE_CONTACT, ...));
@param filter a variant of type %G_VARIANT_TYPE_VARDICT
Register self as a Client.Handler with an empty list of filters.
This is useful if you want to create a client that only handle channels
for which it's the PreferredHandler.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
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
Asynchronously calls DelegateChannels on the ChannelDispatcher to try
stopping handling channels and pass them to another Handler.
You can then call tp_base_client_delegate_channels_finish() to
get the result of the operation.
a #GList of #TpChannel handled by self
the time at which user action occurred, or #TP_USER_ACTION_TIME_NOT_USER_ACTION if this delegation request is for some reason not involving user action.
Either the well-known bus name (starting with %TP_CLIENT_BUS_NAME_BASE) of the preferred handler for the channels, or %NULL to indicate that any handler but self would be acceptable.
a callback to call when the request is satisfied
Finishes an async channels delegation request started using tp_base_client_delegate_channels_async().
a #GAsyncResult
Returns the set of channels currently handled by this base client or by any other #TpBaseClient with which it shares a unique name.
Only works if tp_base_client_set_handler_request_notification() has been
called.
Returns the list of requests self is likely be asked to handle.
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 bus name of self. Note that doesn't mean the client is
actually owning this name; for example if tp_base_client_register()
has not been called yet or failed.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Return the #TpBaseClient:dbus-daemon construct-only property, which represents the D-Bus connection used to export this client object.
The returned object's reference count is not incremented, so it is not
necessarily valid after self is destroyed.
Returns the set of channels currently handled by this base client or by any other #TpBaseClient with which it shares a unique name.
Return the #TpBaseClient:name construct-only property, which is used as part of the bus name and object path.
Return the object path of self. Note that doesn't mean the client is
actually registered on this path; for example if tp_base_client_register()
has not been called yet or failed.
Only works if tp_base_client_set_handler_request_notification() has been
called.
Returns the list of requests self is likely be asked to handle.
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
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Return the #TpBaseClient:uniquify-name construct-only property; if this is true, the bus name and object path will be made unique by appending a suffix that includes the D-Bus unique name and a per-process counter.
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
Checks whether object has a [floating][floating-ref] reference.
Check if self is currently handling channel.
a #TpChannel
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().
Publish self as an available client. After this method is called, as long
as it continues to exist, it will receive and process whatever events were
requested via the various filters.
Methods that set the filters and other immutable state, such as tp_base_client_add_observer_filter(), cannot be called after this one.
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Change the value of the #TpBaseClient:channel-factory property.
It can't be changed once self has been registered.
an object implementing the #TpClientChannelFactoryInterface interface
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
Turn on support for the org.freedesktop.Telepathy.ChannelRequest.DelegateToPreferredHandler hint.
When receiving a request containing this hint, self will automatically
delegate the channels to the preferred handler of the request and then call
callback to inform the client that it is no longer handling those
channels.
function called when channels currently handled by self are delegated, may not be %NULL
Set whether the channels destined for this handler are automatically handled, without invoking approvers. (This is implemented by setting the value of its BypassApproval D-Bus property.)
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
the value of the Handler.BypassApproval property
Indicate that self is a Handler willing to be notified about requests for
channels that it is likely to be asked to handle. This means that the
#TpBaseClient::request-added and #TpBaseClient::request-removed signals will
be fired and tp_base_client_get_pending_requests() will return the list of
pending requests.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.handle_channels.
Set whether the channel dispatcher should wait for tp_observe_channels_context_accept() or tp_observe_channels_context_fail() to be called before calling #TpBaseClientClass.add_dispatch_operation on appropriate Approvers.
This is implemented by setting the value of the DelayApprovers D-Bus property.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.observe_channels.
the value of the Observer.DelayApprovers property
Set whether the channel dispatcher should attempt to recover this Observer if it crashes. (This is implemented by setting the value of its Recover D-Bus property.)
Normally, Observers are only notified when new channels appear. If an Observer is set to recover, when it registers with tp_base_client_register(), it will also be told about any channels that already existed before it started.
For Observers that are activatable as a D-Bus service, if the Observer exits or crashes while there are any channels that match its filter, it will automatically be restarted by service-activation.
This method may only be called before tp_base_client_register() is called, and may only be called on objects whose class implements #TpBaseClientClass.observe_channels.
the value of the Observer.Recover property
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.
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.
Remove this client object from D-Bus, if tp_base_client_register() has already been called.
If the object is not registered, this method may be called, but has no effect.
Releasing the last reference to the object also has the same effect as calling this method, but this method should be preferred, as it has more deterministic behaviour.
If the object still exists, tp_base_client_register() may be used to attempt to register it again.
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
Convenient function to create a new #TpSimpleHandler instance.
If dbus is not the result of tp_dbus_daemon_dup(), you should call
tp_simple_handler_new_with_am() instead, so that #TpAccount,
#TpConnection and #TpContact instances can be shared between modules.
a #TpDBusDaemon object, may not be %NULL
the value of the Handler.BypassApproval D-Bus property (see tp_base_client_set_handler_bypass_approval() for details)
whether this handler should implement Requests (see tp_base_client_set_handler_request_notification() for details)
the name of the Handler (see #TpBaseClient:name for details)
the value of the #TpBaseClient:uniquify-name property
the function called when HandleChannels is called
Convenient function to create a new #TpSimpleHandler instance with a specified #TpAccountManager.
It is not necessary to prepare any features on account_manager before
calling this function.
an account manager, which may not be %NULL
the value of the Handler.BypassApproval D-Bus property (see tp_base_client_set_handler_bypass_approval() for details)
whether this handler should implement Requests (see tp_base_client_set_handler_request_notification() for details)
the name of the Handler (see #TpBaseClient:name for details)
the value of the #TpBaseClient:uniquify-name property
the function called when HandleChannels is called
Convenient function to create a new #TpSimpleHandler instance with a specified #TpSimpleClientFactory.
a #TpSimpleClientFactory, which may not be %NULL
the value of the Handler.BypassApproval D-Bus property (see tp_base_client_set_handler_bypass_approval() for details)
whether this handler should implement Requests (see tp_base_client_set_handler_request_notification() for details)
the name of the Handler (see #TpBaseClient:name for details)
the value of the #TpBaseClient:uniquify-name property
the function called when HandleChannels is called
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
Data structure representing a simple Handler implementation.