Service-side Properties interface

Service-side Properties interface — GInterface for D-Bus objects exporting Telepathy properties

Synopsis


#include <telepathy-glib/svc-generic.h>


            TpSvcPropertiesInterface;
            TpSvcPropertiesInterfaceClass;
void        (*tp_svc_properties_interface_get_properties_impl)
                                            (TpSvcPropertiesInterface *self,
                                             const GArray *in_properties,
                                             DBusGMethodInvocation *context);
void        tp_svc_properties_interface_return_from_get_properties
                                            (DBusGMethodInvocation *context,
                                             const GPtrArray *out0);
void        tp_svc_properties_interface_implement_get_properties
                                            (TpSvcPropertiesInterfaceClass *klass,
                                             tp_svc_properties_interface_get_properties_impl impl);
void        (*tp_svc_properties_interface_list_properties_impl)
                                            (TpSvcPropertiesInterface *self,
                                             DBusGMethodInvocation *context);
void        tp_svc_properties_interface_return_from_list_properties
                                            (DBusGMethodInvocation *context,
                                             const GPtrArray *out0);
void        tp_svc_properties_interface_implement_list_properties
                                            (TpSvcPropertiesInterfaceClass *klass,
                                             tp_svc_properties_interface_list_properties_impl impl);
void        (*tp_svc_properties_interface_set_properties_impl)
                                            (TpSvcPropertiesInterface *self,
                                             const GPtrArray *in_properties,
                                             DBusGMethodInvocation *context);
void        tp_svc_properties_interface_return_from_set_properties
                                            (DBusGMethodInvocation *context);
void        tp_svc_properties_interface_implement_set_properties
                                            (TpSvcPropertiesInterfaceClass *klass,
                                             tp_svc_properties_interface_set_properties_impl impl);
void        tp_svc_properties_interface_emit_properties_changed
                                            (gpointer instance,
                                             const GPtrArray *arg_properties);
void        tp_svc_properties_interface_emit_property_flags_changed
                                            (gpointer instance,
                                             const GPtrArray *arg_properties);


Description

The Telepathy Properties interface associates a number of named properties with a channel, connection or other D-Bus object. Signals are emitted when the properties or their flags (readable/writable) change.

Details

TpSvcPropertiesInterface

typedef struct _TpSvcPropertiesInterface TpSvcPropertiesInterface;

Dummy typedef representing any implementation of this interface.


TpSvcPropertiesInterfaceClass

typedef struct _TpSvcPropertiesInterfaceClass TpSvcPropertiesInterfaceClass;

The class of TpSvcPropertiesInterface.


tp_svc_properties_interface_get_properties_impl ()

void        (*tp_svc_properties_interface_get_properties_impl)
                                            (TpSvcPropertiesInterface *self,
                                             const GArray *in_properties,
                                             DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method GetProperties on interface org.freedesktop.Telepathy.Properties.

self : The object implementing this interface
in_properties : const GArray * (FIXME, generate documentation)
context : Used to return values or throw an error

tp_svc_properties_interface_return_from_get_properties ()

void        tp_svc_properties_interface_return_from_get_properties
                                            (DBusGMethodInvocation *context,
                                             const GPtrArray *out0);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context : The D-Bus method invocation context
out0 : const GPtrArray * (FIXME, generate documentation)

tp_svc_properties_interface_implement_get_properties ()

void        tp_svc_properties_interface_implement_get_properties
                                            (TpSvcPropertiesInterfaceClass *klass,
                                             tp_svc_properties_interface_get_properties_impl impl);

Register an implementation for the GetProperties method in the vtable of an implementation of this interface. To be called from the interface init function.

klass : A class whose instances implement this interface
impl : A callback used to implement the GetProperties D-Bus method

tp_svc_properties_interface_list_properties_impl ()

void        (*tp_svc_properties_interface_list_properties_impl)
                                            (TpSvcPropertiesInterface *self,
                                             DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method ListProperties on interface org.freedesktop.Telepathy.Properties.

self : The object implementing this interface
context : Used to return values or throw an error

tp_svc_properties_interface_return_from_list_properties ()

void        tp_svc_properties_interface_return_from_list_properties
                                            (DBusGMethodInvocation *context,
                                             const GPtrArray *out0);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context : The D-Bus method invocation context
out0 : const GPtrArray * (FIXME, generate documentation)

tp_svc_properties_interface_implement_list_properties ()

void        tp_svc_properties_interface_implement_list_properties
                                            (TpSvcPropertiesInterfaceClass *klass,
                                             tp_svc_properties_interface_list_properties_impl impl);

Register an implementation for the ListProperties method in the vtable of an implementation of this interface. To be called from the interface init function.

klass : A class whose instances implement this interface
impl : A callback used to implement the ListProperties D-Bus method

tp_svc_properties_interface_set_properties_impl ()

void        (*tp_svc_properties_interface_set_properties_impl)
                                            (TpSvcPropertiesInterface *self,
                                             const GPtrArray *in_properties,
                                             DBusGMethodInvocation *context);

The signature of an implementation of the D-Bus method SetProperties on interface org.freedesktop.Telepathy.Properties.

self : The object implementing this interface
in_properties : const GPtrArray * (FIXME, generate documentation)
context : Used to return values or throw an error

tp_svc_properties_interface_return_from_set_properties ()

void        tp_svc_properties_interface_return_from_set_properties
                                            (DBusGMethodInvocation *context);

Return successfully by calling dbus_g_method_return(). This inline function exists only to provide type-safety.

context : The D-Bus method invocation context

tp_svc_properties_interface_implement_set_properties ()

void        tp_svc_properties_interface_implement_set_properties
                                            (TpSvcPropertiesInterfaceClass *klass,
                                             tp_svc_properties_interface_set_properties_impl impl);

Register an implementation for the SetProperties method in the vtable of an implementation of this interface. To be called from the interface init function.

klass : A class whose instances implement this interface
impl : A callback used to implement the SetProperties D-Bus method

tp_svc_properties_interface_emit_properties_changed ()

void        tp_svc_properties_interface_emit_properties_changed
                                            (gpointer instance,
                                             const GPtrArray *arg_properties);

Type-safe wrapper around g_signal_emit to emit the PropertiesChanged signal on interface org.freedesktop.Telepathy.Properties.

instance : The object implementing this interface
arg_properties : const GPtrArray * (FIXME, generate documentation)

tp_svc_properties_interface_emit_property_flags_changed ()

void        tp_svc_properties_interface_emit_property_flags_changed
                                            (gpointer instance,
                                             const GPtrArray *arg_properties);

Type-safe wrapper around g_signal_emit to emit the PropertyFlagsChanged signal on interface org.freedesktop.Telepathy.Properties.

instance : The object implementing this interface
arg_properties : const GPtrArray * (FIXME, generate documentation)

See Also

TpPropertiesMixin