Service-side Properties interface

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

Synopsis


#include <telepathy-glib/svc-properties-interface.h>


                    TpSvcPropertiesInterface;
                    TpSvcPropertiesInterfaceClass;
void                (*tp_svc_properties_interface_get_properties_impl)
                                                        (TpSvcPropertiesInterface *self,
                                                         const GArray *properties,
                                                         DBusGMethodInvocation *context);
void                tp_svc_properties_interface_return_from_get_properties
                                                        (DBusGMethodInvocation *dbus_context,
                                                         const GPtrArray *ret);
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 *dbus_context,
                                                         const GPtrArray *ret);
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 *properties,
                                                         DBusGMethodInvocation *context);
void                tp_svc_properties_interface_return_from_set_properties
                                                        (DBusGMethodInvocation *dbus_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 *properties);
void                tp_svc_properties_interface_emit_property_flags_changed
                                                        (gpointer instance,
                                                         const GPtrArray *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 *properties,
                                                         DBusGMethodInvocation *context);

Signature of an implementation of D-Bus method GetProperties on interface org.freedesktop.Telepathy.Properties

self :

The object implementing this interface

properties :

FIXME: document args in genginterface

context :

The D-Bus invocation context to use 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 *dbus_context,
                                                         const GPtrArray *ret);

Return successfully by calling dbus_g_method_return (dbus_context, ...). This inline function is just a type-safe wrapper for dbus_g_method_return.

dbus_context :

The D-Bus method invocation context

ret :

FIXME: document args in genginterface

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 method

tp_svc_properties_interface_list_properties_impl ()

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

Signature of an implementation of D-Bus method ListProperties on interface org.freedesktop.Telepathy.Properties

self :

The object implementing this interface

context :

The D-Bus invocation context to use 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 *dbus_context,
                                                         const GPtrArray *ret);

Return successfully by calling dbus_g_method_return (dbus_context, ...). This inline function is just a type-safe wrapper for dbus_g_method_return.

dbus_context :

The D-Bus method invocation context

ret :

FIXME: document args in genginterface

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 method

tp_svc_properties_interface_set_properties_impl ()

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

Signature of an implementation of D-Bus method SetProperties on interface org.freedesktop.Telepathy.Properties

self :

The object implementing this interface

properties :

FIXME: document args in genginterface

context :

The D-Bus invocation context to use 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 *dbus_context);

Return successfully by calling dbus_g_method_return (dbus_context, ...). This inline function is just a type-safe wrapper for dbus_g_method_return.

dbus_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 method

tp_svc_properties_interface_emit_properties_changed ()

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

Emit the PropertiesChanged D-Bus signal from instance with the given arguments.

instance :

An object implementing this interface

properties :

FIXME: document args in genginterface

tp_svc_properties_interface_emit_property_flags_changed ()

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

Emit the PropertyFlagsChanged D-Bus signal from instance with the given arguments.

instance :

An object implementing this interface

properties :

FIXME: document args in genginterface

See Also

TpPropertiesMixin